diff options
| author | Matt Brictson <mattbrictson@users.noreply.github.com> | 2015-06-05 10:37:58 -0700 |
|---|---|---|
| committer | Matt Brictson <mattbrictson@users.noreply.github.com> | 2015-06-05 10:37:58 -0700 |
| commit | 8e86d6dd091cd520f31278b1280b21d0950fc429 (patch) | |
| tree | 04474c5857de53f3a3dc65c151de6eb741db5485 | |
| parent | 46de2dedb0005954d6ec780d2b6cc80cb68c1dac (diff) | |
| download | bundler-8e86d6dd091cd520f31278b1280b21d0950fc429.tar.gz | |
Clarify the purpose of --deployment
The man page originally explained that `--deployment` is not appropriate for the `test` environment, which is misleading. In a CI environment, you *do* want to use `--deployment`, despite the fact that CI will likely be using `RAILS_ENV=test` when running tests.
This PR clarifies that `--deployment` is for production and CI, and avoids explicitly referencing Rails environment names.
| -rw-r--r-- | man/bundle-install.ronn | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/man/bundle-install.ronn b/man/bundle-install.ronn index 381b714ba9..9d16035c5d 100644 --- a/man/bundle-install.ronn +++ b/man/bundle-install.ronn @@ -77,8 +77,8 @@ update process below under [CONSERVATIVE UPDATING][]. * `--deployment`: In [deployment mode][DEPLOYMENT MODE], Bundler will 'roll-out' the bundle for - `production` use. Please check carefully if you want to have this option - enabled in `development` or `test` environments. + production or CI use. Please check carefully if you want to have this option + enabled in your development environment. * `--system`: Installs the gems specified in the bundle to the system's Rubygems location. @@ -142,8 +142,8 @@ update process below under [CONSERVATIVE UPDATING][]. ## DEPLOYMENT MODE Bundler's defaults are optimized for development. To switch to -defaults optimized for deployment, use the `--deployment` flag. -Do not activate deployment mode on development machines, as it +defaults optimized for deployment and for CI, use the `--deployment` +flag. Do not activate deployment mode on development machines, as it will cause an error when the Gemfile(5) is modified. 1. A `Gemfile.lock` is required. |