From 77a228785ccc6832d8e30438380aea7ad9706a70 Mon Sep 17 00:00:00 2001 From: Ryan Bigg Date: Wed, 1 Dec 2010 17:18:41 +1100 Subject: [PATCH] Add gem method documentation to the generators guide --- railties/guides/source/generators.textile | 28 +++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/railties/guides/source/generators.textile b/railties/guides/source/generators.textile index c57171f189..915270ff46 100644 --- a/railties/guides/source/generators.textile +++ b/railties/guides/source/generators.textile @@ -423,6 +423,34 @@ Available options are: * +:svn+ - Takes the path to the svn repository where this plugin can be found. * +:revision+ - The revision of the plugin in an SVN repository. +h4. +gem+ + +Specifies a gem dependency of the application. + + + gem("rspec", :group => "test", :version => "2.1.0") + gem("devise", "1.1.5") + + +Available options are: + +* +:group+ - The group in the +Gemfile+ where this gem should go. +* +:version+ - The version string of the gem you want to use. Can also be specified as the second argument to the method. +* +:git+ - The URL to the git repository for this gem. + +Any additional options passed to this method are put on the end of the line: + + + gem("devise", :git => "git://github.com/plataformatec/devise", :branch => "master") + + +The above code will put the following line into +Gemfile+: + + + gem "devise", :git => "git://github.com/plataformatec/devise", :branch => "master" + + + h3. Changelog