Skip to content
This repository was archived by the owner on Apr 14, 2021. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions man/bundle-config.ronn
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,35 @@ local and global sources. Not compatible with --global or --local flag.
Executing bundle with the `BUNDLE_IGNORE_CONFIG` environment variable set will
cause it to ignore all configuration.

## 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
Expand Down
45 changes: 5 additions & 40 deletions man/bundle-install.ronn
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,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
Expand Down Expand Up @@ -79,7 +82,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
Expand All @@ -94,8 +97,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
Expand Down Expand Up @@ -125,8 +127,6 @@ update process below under [CONSERVATIVE UPDATING][].

* `--without=<list>`:
A space-separated list of groups referencing gems to skip during installation.
This is a [remembered option][REMEMBERED OPTIONS].


## DEPLOYMENT MODE

Expand Down Expand Up @@ -251,41 +251,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
Expand Down