diff options
author | David RodrÃguez <deivid.rodriguez@riseup.net> | 2019-02-19 10:50:03 +0100 |
---|---|---|
committer | David RodrÃguez <deivid.rodriguez@riseup.net> | 2019-02-19 17:21:11 +0100 |
commit | 42ca30343dbce29ba618d3cefda89f359406eb9c (patch) | |
tree | ca71d061e451fddda06cb0d1417a375798e022e6 /man | |
parent | 5dc368b07c407702a485ed53d8fd8a8ab40fa9ef (diff) | |
download | bundler-42ca30343dbce29ba618d3cefda89f359406eb9c.tar.gz |
Use newest interface to `bundle config` everywhere
Diffstat (limited to 'man')
-rw-r--r-- | man/bundle-config.ronn | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn index 81e0aa303c..75a1934b00 100644 --- a/man/bundle-config.ronn +++ b/man/bundle-config.ronn @@ -20,35 +20,35 @@ 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 +Executing `bundle config get <name>` will print the value of that configuration setting, and where it was set. -Executing `bundle config <name> <value>` will set that configuration to the +Executing `bundle config set <name> <value>` will set that configuration to the value specified for all bundles executed as the current user. The configuration will be stored in `~/.bundle/config`. If <name> already is set, <name> will be overridden and user will be warned. -Executing `bundle config --global <name> <value>` works the same as above. +Executing `bundle config set --global <name> <value>` works the same as above. -Executing `bundle config --local <name> <value>` will set that configuration to +Executing `bundle config set --local <name> <value>` will set that configuration to the local application. The configuration will be stored in `app/.bundle/config`. -Executing `bundle config --delete <name>` will delete the configuration in both +Executing `bundle config unset <name>` will delete the configuration in both 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. -Executing `bundle config disable_multisource true` upgrades the warning about +Executing `bundle config set 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. +config unset 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`). +(e.g., `bundle config set path foo`). The options that can be configured are: @@ -92,7 +92,7 @@ pass configuration flags to `gem install` to specify where to find the Since the specific location of that executable can change from machine to machine, you can specify these flags on a per-machine basis. - bundle config build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config + bundle config set build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config After running this command, every time bundler needs to install the `mysql` gem, it will pass along the flags you specified. @@ -169,7 +169,7 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html). * `disable_multisource` (`BUNDLE_DISABLE_MULTISOURCE`): When set, Gemfiles containing multiple sources will produce errors instead of warnings. - Use `bundle config --delete disable_multisource` to unset. + Use `bundle config unset disable_multisource` to unset. * `disable_platform_warnings` (`BUNDLE_DISABLE_PLATFORM_WARNINGS`): Disable warnings during bundle install when a dependency is unused on the current platform. * `disable_shared_gems` (`BUNDLE_DISABLE_SHARED_GEMS`): @@ -302,11 +302,11 @@ Bundler also allows you to work against a git repository locally instead of using the remote version. This can be achieved by setting up a local override: - bundle config local.GEM_NAME /path/to/local/git/repository + bundle config set local.GEM_NAME /path/to/local/git/repository For example, in order to use a local Rack repository, a developer could call: - bundle config local.rack ~/Work/git/rack + bundle config set local.rack ~/Work/git/rack Now instead of checking out the remote git repository, the local override will be used. Similar to a path source, every time the local @@ -336,21 +336,21 @@ Bundler supports overriding gem sources with mirrors. This allows you to configure rubygems.org as the gem source in your Gemfile while still using your mirror to fetch gems. - bundle config mirror.SOURCE_URL MIRROR_URL + bundle config set mirror.SOURCE_URL MIRROR_URL For example, to use a mirror of rubygems.org hosted at rubygems-mirror.org: - bundle config mirror.http://rubygems.org http://rubygems-mirror.org + bundle config set mirror.http://rubygems.org http://rubygems-mirror.org Each mirror also provides a fallback timeout setting. If the mirror does not respond within the fallback timeout, Bundler will try to use the original server instead of the mirror. - bundle config mirror.SOURCE_URL.fallback_timeout TIMEOUT + bundle config set mirror.SOURCE_URL.fallback_timeout TIMEOUT For example, to fall back to rubygems.org after 3 seconds: - bundle config mirror.https://rubygems.org.fallback_timeout 3 + bundle config set mirror.https://rubygems.org.fallback_timeout 3 The default fallback timeout is 0.1 seconds, but the setting can currently only accept whole seconds (for example, 1, 15, or 30). @@ -360,12 +360,12 @@ only accept whole seconds (for example, 1, 15, or 30). Bundler allows you to configure credentials for any gem source, which allows you to avoid putting secrets into your Gemfile. - bundle config SOURCE_HOSTNAME USERNAME:PASSWORD + bundle config set SOURCE_HOSTNAME USERNAME:PASSWORD For example, to save the credentials of user `claudette` for the gem source at `gems.longerous.com`, you would run: - bundle config gems.longerous.com claudette:s00pers3krit + bundle config set gems.longerous.com claudette:s00pers3krit Or you can set the credentials as an environment variable like this: @@ -373,7 +373,7 @@ Or you can set the credentials as an environment variable like this: For gems with a git source with HTTP(S) URL you can specify credentials like so: - bundle config https://github.com/bundler/bundler.git username:password + bundle config set https://github.com/bundler/bundler.git username:password Or you can set the credentials as an environment variable like so: |