aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLes Nightingill <codehacker@comcast.net>2012-05-26 09:53:16 -0700
committerLes Nightingill <codehacker@comcast.net>2012-05-26 09:53:16 -0700
commitdc8957a077396e419f5e1ec4dfddf65b1aa52227 (patch)
treeb6fa3f23f4905b22591dc543e4095bf4a6b8111a
parent2114e2187dd8cbdcc0ab304ec0adf1a1bf5cc09a (diff)
downloadrails-dc8957a077396e419f5e1ec4dfddf65b1aa52227.tar.gz
rails-dc8957a077396e419f5e1ec4dfddf65b1aa52227.tar.bz2
rails-dc8957a077396e419f5e1ec4dfddf65b1aa52227.zip
add small note about how to get the full list of options for rails plugin new
-rw-r--r--guides/source/engines.textile6
1 files changed, 6 insertions, 0 deletions
diff --git a/guides/source/engines.textile b/guides/source/engines.textile
index c35305a822..86e7254201 100644
--- a/guides/source/engines.textile
+++ b/guides/source/engines.textile
@@ -36,6 +36,12 @@ To generate an engine with Rails 3.1, you will need to run the plugin generator
$ rails plugin new blorgh --full --mountable
</shell>
+The full list of options for the plugin generator may be seen by typing:
+
+<shell>
+$ rails plugin --help
+</shell>
+
The +--full+ option tells the plugin generator that you want to create an engine (which is a mountable plugin, hence the option name), creating the basic directory structure of an engine by providing things such as the foundations of an +app+ folder, as well a +config/routes.rb+ file. This generator also provides a file at +lib/blorgh/engine.rb+ which is identical in function to an application's +config/application.rb+ file.
The +--mountable+ option tells the generator to mount the engine inside the dummy testing application located at +test/dummy+ inside the engine. It does this by placing this line in to the dummy application's +config/routes.rb+ file, located at +test/dummy/config/routes.rb+ inside the engine: