Permalink
Browse files

Merge pull request #1848 from ZoFreX/master

Added documentation of the new :github option for gemfiles
  • Loading branch information...
2 parents 51424a7 + 40c36ec commit d195524411f1cb55757eb02fa5b0e0d8270398fb @radar radar committed Apr 13, 2012
Showing with 14 additions and 0 deletions.
  1. +14 −0 man/gemfile.5.ronn
View
@@ -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

0 comments on commit d195524

Please sign in to comment.