summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Lance <stefan@lances.net>2015-04-18 22:49:03 -0500
committerSamuel E. Giddins <segiddins@segiddins.me>2015-07-16 08:21:47 -0700
commitc5c927d0c2ca181effb50694da6064e05b2cc5ab (patch)
treecd1175dfa70f3ca8de5756355b03e611b79820b5
parent46a43a96aa46f72d3f715d79c53060c8fe8f3b6a (diff)
downloadbundler-c5c927d0c2ca181effb50694da6064e05b2cc5ab.tar.gz
Edit config & install docs re: remembered flags
-rw-r--r--man/bundle-config.ronn32
-rw-r--r--man/bundle-install.ronn47
2 files changed, 38 insertions, 41 deletions
diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn
index 5e1691b456..75161294ff 100644
--- a/man/bundle-config.ronn
+++ b/man/bundle-config.ronn
@@ -39,6 +39,38 @@ Executing `bundle config disable_multisource true` upgrades the warning about
the Gemfile containing multiple primary sources to an error. Executing `bundle
config --delete disable_multisource` downgrades this error to a warning.
+## REMEMBERING OPTIONS
+
+Flags passed to `bundle install` or the Bundler runtime,
+such as `--path foo` or `--without production`, are not remembered between commands.
+If these options must be remembered,they must be set using `bundle config`
+(e.g., `bundle config path foo`).
+
+The options that can be configured are:
+
+* `binstubs`:
+ Creates a directory (defaults to `~/bin`) and place any executables from the
+ gem there. These executables run in Bundler's context. If used, you might add
+ this directory to your environment's `PATH` variable. For instance, if the
+ `rails` gem comes with a `rails` executable, this flag will create a
+ `bin/rails` executable that ensures that all referred dependencies will be
+ resolved using the bundled gems.
+
+* `deployment`:
+ In 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.
+
+* `path`:
+ The location to install the specified gems to. This defaults to Rubygems'
+ setting. Bundler shares this location with Rubygems, `gem install ...` will
+ have gem installed there, too. Therefore, gems installed without a
+ `--path ...` setting will show up by calling `gem list`. Accodingly, gems
+ installed to other locations will not get listed.
+
+* `without`:
+ A space-separated list of groups referencing gems to skip during installation.
+
## BUILD OPTIONS
You can use `bundle config` to give bundler the flags to pass to the gem
diff --git a/man/bundle-install.ronn b/man/bundle-install.ronn
index 4912ccd1b2..272007091d 100644
--- a/man/bundle-install.ronn
+++ b/man/bundle-install.ronn
@@ -42,6 +42,9 @@ update process below under [CONSERVATIVE UPDATING][].
## OPTIONS
+To apply any of `--deployment`, `--path`, `--binstubs`, or `--without` every
+time `bundle install` is run, use `bundle config` (see bundle-config(1)).
+
* `--binstubs[=<directory>]`:
Creates a directory (defaults to `~/bin`) and place any executables from the
gem there. These executables run in Bundler's context. If used, you might add
@@ -87,7 +90,7 @@ update process below under [CONSERVATIVE UPDATING][].
* `--system`:
Installs the gems specified in the bundle to the system's Rubygems location.
- This overrides any previous [remembered][REMEMBERED OPTIONS] use of `--path`.
+ This overrides any previous configuration of `--path`.
* `--no-cache`:
Do not update the cache in `vendor/cache` with the newly bundled gems. This
@@ -102,8 +105,7 @@ update process below under [CONSERVATIVE UPDATING][].
setting. Bundler shares this location with Rubygems, `gem install ...` will
have gem installed there, too. Therefore, gems installed without a
`--path ...` setting will show up by calling `gem list`. Accodingly, gems
- installed to other locations will not get listed. This setting is a
- [remembered option][REMEMBERED OPTIONS].
+ installed to other locations will not get listed.
* `--quiet`:
Do not print progress information to the standard output. Instead, Bundler
@@ -135,14 +137,12 @@ update process below under [CONSERVATIVE UPDATING][].
A space-separated list of groups referencing gems to skip during installation.
If a group is given that is in the remembered list of groups given
to --with, it is removed from that list.
- This is a [remembered option][REMEMBERED OPTIONS].
* `--with=<list>`:
A space-separated list of groups referencing gems to install. If an
optional group is given it is installed. If a group is given that is
in the remembered list of groups given to --without, it is removed
- from that list. This is a [remembered option][REMEMBERED OPTIONS].
-
+ from that list.
## DEPLOYMENT MODE
@@ -267,41 +267,6 @@ the vagaries of the dependency resolution process, this usually
affects more than just the gems you list in your Gemfile(5), and can
(surprisingly) radically change the gems you are using.
-## REMEMBERED OPTIONS
-
-Some options (marked above in the [OPTIONS][] section) are remembered
-between calls to `bundle install`, and by the Bundler runtime.
-
-For instance, if you run `bundle install --without test`, a subsequent
-call to `bundle install` that does not include a `--without` flag will
-remember your previous choice.
-
-In addition, a call to `Bundler.setup` will not attempt to make the
-gems in those groups available on the Ruby load path, as they were
-not installed.
-
-The settings that are remembered are:
-
-* `--deployment`:
- At runtime, this remembered setting will also result in Bundler
- raising an exception if the `Gemfile.lock` is out of date.
-
-* `--path`:
- Subsequent calls to `bundle install` will install gems to the
- directory originally passed to `--path`. The Bundler runtime
- will look for gems in that location. You can revert this
- option by running `bundle install --system`.
-
-* `--binstubs`:
- Bundler will update the executables every subsequent call to
- `bundle install`.
-
-* `--without`:
- As described above, Bundler will skip the gems specified by
- `--without` in subsequent calls to `bundle install`. The
- Bundler runtime will also not try to make the gems in the
- skipped groups available.
-
## THE GEMFILE.LOCK
When you run `bundle install`, Bundler will persist the full names