aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames Sanderson <zofrex@gmail.com>2012-04-13 15:34:56 +0100
committerJames Sanderson <zofrex@gmail.com>2012-04-13 15:34:56 +0100
commit40c36ec95e9805426caba8ceecc5d1ae9b9e23fe (patch)
treef5edf19a4ee1d16414c3439df321499ff8be0163
parent51424a7b821c02d636bae21652c6d62e6d8f4145 (diff)
downloadbundler-40c36ec95e9805426caba8ceecc5d1ae9b9e23fe.tar.gz
Added :github to gemfile documentation
-rw-r--r--man/gemfile.5.ronn14
1 files changed, 14 insertions, 0 deletions
diff --git a/man/gemfile.5.ronn b/man/gemfile.5.ronn
index 5ac73a7e..7ef7a4e3 100644
--- a/man/gemfile.5.ronn
+++ b/man/gemfile.5.ronn
@@ -210,6 +210,20 @@ and then installs the resulting gem. The `gem build` command,
which comes standard with Rubygems, evaluates the `.gemspec` in
the context of the directory in which it is located.
+### GITHUB (:github)
+
+If the git repository you want to use is hosted on GitHub and is public, you can use the
+:github shorthand to specify just the github username and repository name (without the
+trailing ".git"), separated by a slash. If both the username and repository name are the
+same, you can omit one.
+
+ gem "rails", :github => "rails/rails"
+ gem "rails", :github => "rails"
+
+Are both equivalent to
+
+ gem "rails", :github => :git://github.com/rails/rails.git"
+
### PATH (:path)
You can specify that a gem is located in a particular location