warn against --deployment in development

ruprict · Apr 6, 2011 · 0f500c0 · 0f500c0
1 parent 489fa63
commit 0f500c0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/src/pages/bundle_install.haml b/src/pages/bundle_install.haml
@@ -42,7 +42,8 @@
 
   .bullet
     .description
-      Install all dependencies using defaults appropriate for deployment.
+      Install all dependencies on to a production server.
+      Do <b>not</b> use this flag on a development machine.
     :highlight_plain
       $ bundle install --deployment
     .notes

diff --git a/src/pages/index.haml b/src/pages/index.haml
@@ -174,14 +174,15 @@
 .contents
   .bullet
     .description
-      On your deployment box, install your app's dependencies to an isolated directory
+      On production servers, you can enable deployment mode:
     :highlight_plain
       $ bundle install --deployment
     .notes
-      The <code>--deployment</code> flag turns on defaults that
-      are appropriate for a deployment environment. For instance,
-      gems are installed to <code>vendor/bundle</code> by default
-      and your <code>Gemfile.lock</code> must be up to date.
+      Do <b>not</b> use this flag on development machines. The
+      <code>--deployment</code> flag turns on defaults that are appropriate for
+      a deployment environment. Gems are installed to
+      <code>vendor/bundle</code> and the <code>Gemfile.lock</code> must be
+      checked in and up to date before Bundler is run.
     = link("Learn More: deploying", "./deploying.html")
 
 %h2#digging-further