man/bundle-config.ronn in bundler-1.16.1 vs man/bundle-config.ronn in bundler-1.16.2

- old
+ new

@@ -5,15 +5,19 @@ `bundle config` [<name> [<value>]] ## DESCRIPTION -This command allows you to interact with bundler's configuration system. -Bundler retrieves its configuration from the local application (`app/.bundle/config`), -environment variables, and the user's home directory (`~/.bundle/config`), -in that order of priority. +This command allows you to interact with Bundler's configuration system. +Bundler loads configuration settings in this order: + +1. Local config (`app/.bundle/config`) +2. Environmental variables (`ENV`) +3. Global config (`~/.bundle/config`) +4. Bundler default config + Executing `bundle config` with no parameters will print a list of all bundler configuration for the current bundle, and where that configuration was set. Executing `bundle config <name>` will print the value of that configuration @@ -74,11 +78,11 @@ * `with`: A space-separated list of groups referencing gems to include during installation. ## BUILD OPTIONS -You can use `bundle config` to give bundler the flags to pass to the gem +You can use `bundle config` to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem. A very common example, the `mysql` gem, requires Snow Leopard users to pass configuration flags to `gem install` to specify where to find the `mysql_config` executable. @@ -96,15 +100,15 @@ ## CONFIGURATION KEYS Configuration keys in bundler have two forms: the canonical form and the environment variable form. -For instance, passing the `--without` flag to [bundle install(1)][bundle-install] +For instance, passing the `--without` flag to [bundle install(1)][bundle-install(1)] prevents Bundler from installing certain groups specified in the Gemfile(5). Bundler persists this value in `app/.bundle/config` so that calls to `Bundler.setup` do not try to find gems from the `Gemfile` that you didn't install. Additionally, -subsequent calls to [bundle install(1)][bundle-install] remember this setting +subsequent calls to [bundle install(1)][bundle-install(1)] remember this setting and skip those groups. The canonical form of this configuration is `"without"`. To convert the canonical form to the environment variable form, capitalize it, and prepend `BUNDLE_`. The environment variable form of `"without"` is `BUNDLE_WITHOUT`. @@ -114,11 +118,11 @@ the environment variable `BUNDLE_LOCAL__RACK`. ## LIST OF AVAILABLE KEYS The following is a list of all configuration keys and their purpose. You can -learn more about their operation in [bundle install(1)][bundle-install]. +learn more about their operation in [bundle install(1)][bundle-install(1)]. * `allow_bundler_dependency_conflicts` (`BUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS`): Allow resolving to specifications that have dependencies on `bundler` that are incompatible with the running Bundler version. * `allow_deployment_source_credential_changes` (`BUNDLE_ALLOW_DEPLOYMENT_SOURCE_CREDENTIAL_CHANGES`): @@ -275,10 +279,10 @@ A `:`-separated list of groups whose gems bundler should install. * `without` (`BUNDLE_WITHOUT`): A `:`-separated list of groups whose gems bundler should not install. In general, you should set these settings per-application by using the applicable -flag to the [bundle install(1)][bundle-install] or [bundle package(1)][bundle-package] command. +flag to the [bundle install(1)][bundle-install(1)] or [bundle package(1)][bundle-package(1)] command. You can set them globally either via environment variables or `bundle config`, whichever is preferable for your setup. If you use both, environment variables will take preference over global settings.