bundler 2.0.2 → 2.1.0.pre.1

data/man/bundle-config.1.txt

@@ -6,7 +6,7 @@ NAME
        bundle-config - Set bundler configuration options
 
 SYNOPSIS
-       bundle config [name [value]]
+       bundle config [list|get|set|unset] [name [value]]
 
 DESCRIPTION
        This  command  allows you to interact with Bundler's configuration sys-
@@ -24,42 +24,50 @@ DESCRIPTION
 
 
 
-       Executing bundle config with no parameters will print  a  list  of  all
-       bundler configuration for the current bundle, and where that configura-
-       tion was set.
+       Executing bundle config list with will print a list of all bundler con-
+       figuration  for	the  current  bundle, and where that configuration was
+       set.
 
-       Executing bundle config <name> will print the value of that  configura-
-       tion setting, and where it was set.
+       Executing bundle config get <name> will print the value of that config-
+       uration setting, and where it was set.
 
-       Executing  bundle  config <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 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
+       Executing bundle config set --global <name> <value> works the  same  as
        above.
 
-       Executing bundle config --local <name> <value> will set that configura-
-       tion to the local application. The  configuration  will	be  stored  in
-       app/.bundle/config.
+       Executing  bundle  config set --local <name> <value> will set that con-
+       figuration to the local application. The configuration will  be	stored
+       in app/.bundle/config.
 
-       Executing  bundle  config --delete <name> will delete the configuration
-       in both local and global  sources.  Not	compatible  with  --global  or
-       --local flag.
+       Executing  bundle  config unset <name> will delete the configuration in
+       both local and global sources.
+
+       Executing bundle config unset --global <name> will delete the  configu-
+       ration only from the user configuration.
+
+       Executing  bundle  config  unset --local <name> <value> will delete the
+       configuration only from the local application.
 
        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 the Gemfile containing multiple primary sources to an error. Exe-
-       cuting bundle config --delete disable_multisource downgrades this error
+       Executing bundle config set disable_multisource true upgrades the warn-
+       ing about the Gemfile containing multiple primary sources to an	error.
+       Executing bundle 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).
+       Flags passed to bundle install or the Bundler runtime, such  as	--path
+       foo  or --without production, are remembered between commands and saved
+       to your local application's configuration (normally, ./.bundle/config).
+
+       However, this will be changed in bundler 3, so it's better not to  rely
+       on  this  behavior. If these options must be remembered, it's better to
+       set them using bundle config (e.g., bundle config set path foo).
 
        The options that can be configured are:
 
@@ -109,7 +117,7 @@ BUILD OPTIONS
 
 
 
-	   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
 
 
 
@@ -174,7 +182,7 @@ LIST OF AVAILABLE KEYS
 
        o   cache_path (BUNDLE_CACHE_PATH): The	directory  that  bundler  will
 	   place  cached gems in when running bundle package, and that bundler
-	   will look in when installing gems. Defaults to vendor/bundle.
+	   will look in when installing gems. Defaults to vendor/cache.
 
        o   clean (BUNDLE_CLEAN): Whether Bundler should run bundle clean auto-
 	   matically after bundle install.
@@ -203,22 +211,19 @@ LIST OF AVAILABLE KEYS
 
        o   disable_multisource	(BUNDLE_DISABLE_MULTISOURCE):  When  set, Gem-
 	   files containing multiple sources will produce  errors  instead  of
-	   warnings.  Use bundle config --delete disable_multisource to unset.
+	   warnings. Use bundle config unset disable_multisource to unset.
 
-       o   disable_platform_warnings (BUNDLE_DISABLE_PLATFORM_WARNINGS):  Dis-
-	   able  warnings during bundle install when a dependency is unused on
+       o   disable_platform_warnings  (BUNDLE_DISABLE_PLATFORM_WARNINGS): Dis-
+	   able warnings during bundle install when a dependency is unused  on
 	   the current platform.
 
        o   disable_shared_gems (BUNDLE_DISABLE_SHARED_GEMS): Stop Bundler from
 	   accessing gems installed to RubyGems' normal location.
 
-       o   disable_version_check  (BUNDLE_DISABLE_VERSION_CHECK): Stop Bundler
-	   from  checking  if  a  newer  Bundler  version  is	available   on
+       o   disable_version_check (BUNDLE_DISABLE_VERSION_CHECK): Stop  Bundler
+	   from   checking   if  a  newer  Bundler  version  is  available  on
 	   rubygems.org.
 
-       o   error_on_stderr  (BUNDLE_ERROR_ON_STDERR):  Print Bundler errors to
-	   stderr.
-
        o   force_ruby_platform (BUNDLE_FORCE_RUBY_PLATFORM): Ignore  the  cur-
 	   rent  machine's  platform and install only ruby platform gems. As a
 	   result, gems with native extensions will be compiled from source.
@@ -242,54 +247,44 @@ LIST OF AVAILABLE KEYS
 	   cache all gems globally, rather than locally to the installing Ruby
 	   installation.
 
-       o   global_path_appends_ruby_scope				 (BUN-
-	   DLE_GLOBAL_PATH_APPENDS_RUBY_SCOPE): Whether Bundler should	append
-	   the	Ruby scope (e.g. engine and ABI version) to a globally-config-
-	   ured path.
-
        o   ignore_messages (BUNDLE_IGNORE_MESSAGES): When set, no post install
 	   messages will be printed. To silence a single gem, use dot notation
 	   like ignore_messages.httparty true.
 
-       o   init_gems_rb (BUNDLE_INIT_GEMS_RB) Generate a gems.rb instead of  a
+       o   init_gems_rb  (BUNDLE_INIT_GEMS_RB) Generate a gems.rb instead of a
 	   Gemfile when running bundle init.
 
-       o   jobs  (BUNDLE_JOBS): The number of gems Bundler can install in par-
+       o   jobs (BUNDLE_JOBS): The number of gems Bundler can install in  par-
 	   allel. Defaults to 1.
 
-       o   list_command (BUNDLE_LIST_COMMAND) Enable new list command feature
-
-       o   major_deprecations  (BUNDLE_MAJOR_DEPRECATIONS):  Whether   Bundler
-	   should print deprecation warnings for behavior that will be changed
-	   in the next major version.
-
-       o   no_install (BUNDLE_NO_INSTALL): Whether bundle package should  skip
+       o   no_install  (BUNDLE_NO_INSTALL): Whether bundle package should skip
 	   installing gems.
 
-       o   no_prune  (BUNDLE_NO_PRUNE):  Whether Bundler should leave outdated
+       o   no_prune (BUNDLE_NO_PRUNE): Whether Bundler should  leave  outdated
 	   gems unpruned when caching.
 
        o   only_update_to_newer_versions     (BUNDLE_ONLY_UPDATE_TO_NEWER_VER-
 	   SIONS): During bundle update, only resolve to newer versions of the
 	   gems in the lockfile.
 
-       o   path (BUNDLE_PATH): The location on disk where  all	gems  in  your
+       o   path  (BUNDLE_PATH):  The  location	on disk where all gems in your
 	   bundle will be located regardless of $GEM_HOME or $GEM_PATH values.
-	   Bundle gems not found in this location will be installed by	bundle
-	   install.  Defaults  to Gem.dir. When --deployment is used, defaults
+	   Bundle  gems not found in this location will be installed by bundle
+	   install. Defaults to Gem.dir. When --deployment is  used,  defaults
 	   to vendor/bundle.
 
-       o   path.system (BUNDLE_PATH__SYSTEM):  Whether	Bundler  will  install
+       o   path.system	(BUNDLE_PATH__SYSTEM):	Whether  Bundler  will install
 	   gems into the default system path (Gem.dir).
 
-       o   path_relative_to_cwd   (BUNDLE_PATH_RELATIVE_TO_CWD)  Makes	--path
+       o   path_relative_to_cwd  (BUNDLE_PATH_RELATIVE_TO_CWD)	Makes	--path
 	   relative to the CWD instead of the Gemfile.
 
        o   plugins (BUNDLE_PLUGINS): Enable Bundler's experimental plugin sys-
 	   tem.
 
-       o   prefer_gems_rb  (BUNDLE_PREFER_GEMS_RB)  Prefer  gems.rb to Gemfile
-	   when Bundler is searching for a Gemfile.
+       o   prefer_patch (BUNDLE_PREFER_PATCH): Prefer updating	only  to  next
+	   patch  version during updates. Makes bundle update calls equivalent
+	   to bundler update --patch.
 
        o   print_only_version_number (BUNDLE_PRINT_ONLY_VERSION_NUMBER)  Print
 	   only version number from bundler --version.
@@ -308,6 +303,10 @@ LIST OF AVAILABLE KEYS
 	   for generated binstubs. Defaults to the ruby install name  used  to
 	   generate the binstub.
 
+       o   silence_deprecations (BUNDLE_SILENCE_DEPRECATIONS): Whether Bundler
+	   should silence deprecation  warnings  for  behavior	that  will  be
+	   changed in the next major version.
+
        o   silence_root_warning   (BUNDLE_SILENCE_ROOT_WARNING):  Silence  the
 	   warning Bundler prints when installing gems as root.
 
@@ -378,7 +377,7 @@ LOCAL GIT REPOS
 
 
 
-	   bundle config local.GEM_NAME /path/to/local/git/repository
+	   bundle config set local.GEM_NAME /path/to/local/git/repository
 
 
 
@@ -387,7 +386,7 @@ LOCAL GIT REPOS
 
 
 
-	   bundle config local.rack ~/Work/git/rack
+	   bundle config set local.rack ~/Work/git/rack
 
 
 
@@ -420,7 +419,7 @@ MIRRORS OF GEM SOURCES
 
 
 
-	   bundle config mirror.SOURCE_URL MIRROR_URL
+	   bundle config set mirror.SOURCE_URL MIRROR_URL
 
 
 
@@ -429,7 +428,7 @@ MIRRORS OF GEM SOURCES
 
 
 
-	   bundle config mirror.http://rubygems.org http://rubygems-mirror.org
+	   bundle config set mirror.http://rubygems.org http://rubygems-mirror.org
 
 
 
@@ -439,7 +438,7 @@ MIRRORS OF GEM SOURCES
 
 
 
-	   bundle config mirror.SOURCE_URL.fallback_timeout TIMEOUT
+	   bundle config set mirror.SOURCE_URL.fallback_timeout TIMEOUT
 
 
 
@@ -447,7 +446,7 @@ MIRRORS OF GEM SOURCES
 
 
 
-	   bundle config mirror.https://rubygems.org.fallback_timeout 3
+	   bundle config set mirror.https://rubygems.org.fallback_timeout 3
 
 
 
@@ -460,7 +459,7 @@ CREDENTIALS FOR GEM SOURCES
 
 
 
-	   bundle config SOURCE_HOSTNAME USERNAME:PASSWORD
+	   bundle config set SOURCE_HOSTNAME USERNAME:PASSWORD
 
 
 
@@ -469,7 +468,7 @@ CREDENTIALS FOR GEM SOURCES
 
 
 
-	   bundle config gems.longerous.com claudette:s00pers3krit
+	   bundle config set gems.longerous.com claudette:s00pers3krit
 
 
 
@@ -486,7 +485,7 @@ CREDENTIALS FOR GEM SOURCES
 
 
 
-	   bundle config https://github.com/bundler/bundler.git username:password
+	   bundle config set https://github.com/bundler/bundler.git username:password
 
 
 
@@ -526,4 +525,4 @@ CONFIGURE BUNDLER DIRECTORIES
 
 
 
-				   June 2019		      BUNDLE-CONFIG(1)
+				  August 2019		      BUNDLE-CONFIG(1)

data/man/bundle-config.ronn

@@ -3,7 +3,7 @@ bundle-config(1) -- Set bundler configuration options
 
 ## SYNOPSIS
 
-`bundle config` [<name> [<value>]]
+`bundle config` [list|get|set|unset] [<name> [<value>]]
 
 ## DESCRIPTION
 
@@ -16,39 +16,48 @@ Bundler loads configuration settings in this order:
 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
+Executing `bundle config list` with 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
-local and global sources. Not compatible with --global or --local flag.
+Executing `bundle config unset <name>` will delete the configuration in both
+local and global sources.
+
+Executing `bundle config unset --global <name>` will delete the configuration
+only from the user configuration.
+
+Executing `bundle config unset --local <name> <value>` will delete the
+configuration only from the local application.
 
 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`).
+Flags passed to `bundle install` or the Bundler runtime, such as `--path foo` or
+`--without production`, are remembered between commands and saved to your local
+application's configuration (normally, `./.bundle/config`).
+
+However, this will be changed in bundler 3, so it's better not to rely on this
+behavior. If these options must be remembered, it's better to set them using
+`bundle config` (e.g., `bundle config set path foo`).
 
 The options that can be configured are:
 
@@ -92,7 +101,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.
@@ -145,7 +154,7 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
 * `cache_path` (`BUNDLE_CACHE_PATH`):
    The directory that bundler will place cached gems in when running
    <code>bundle package</code>, and that bundler will look in when installing gems.
-   Defaults to `vendor/bundle`.
+   Defaults to `vendor/cache`.
 * `clean` (`BUNDLE_CLEAN`):
    Whether Bundler should run `bundle clean` automatically after
    `bundle install`.
@@ -169,7 +178,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`):
@@ -177,8 +186,6 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
 * `disable_version_check` (`BUNDLE_DISABLE_VERSION_CHECK`):
    Stop Bundler from checking if a newer Bundler version is available on
    rubygems.org.
-* `error_on_stderr` (`BUNDLE_ERROR_ON_STDERR`):
-   Print Bundler errors to stderr.
 * `force_ruby_platform` (`BUNDLE_FORCE_RUBY_PLATFORM`):
    Ignore the current machine's platform and install only `ruby` platform gems.
    As a result, gems with native extensions will be compiled from source.
@@ -198,9 +205,6 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
 * `global_gem_cache` (`BUNDLE_GLOBAL_GEM_CACHE`):
    Whether Bundler should cache all gems globally, rather than locally to the
    installing Ruby installation.
-* `global_path_appends_ruby_scope` (`BUNDLE_GLOBAL_PATH_APPENDS_RUBY_SCOPE`):
-   Whether Bundler should append the Ruby scope (e.g. engine and ABI version)
-   to a globally-configured path.
 * `ignore_messages` (`BUNDLE_IGNORE_MESSAGES`): When set, no post install
    messages will be printed. To silence a single gem, use dot notation like
    `ignore_messages.httparty true`.
@@ -208,11 +212,6 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
    Generate a `gems.rb` instead of a `Gemfile` when running `bundle init`.
 * `jobs` (`BUNDLE_JOBS`):
    The number of gems Bundler can install in parallel. Defaults to 1.
-* `list_command` (`BUNDLE_LIST_COMMAND`)
-   Enable new list command feature
-* `major_deprecations` (`BUNDLE_MAJOR_DEPRECATIONS`):
-   Whether Bundler should print deprecation warnings for behavior that will
-   be changed in the next major version.
 * `no_install` (`BUNDLE_NO_INSTALL`):
    Whether `bundle package` should skip installing gems.
 * `no_prune` (`BUNDLE_NO_PRUNE`):
@@ -231,8 +230,8 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
    Makes `--path` relative to the CWD instead of the `Gemfile`.
 * `plugins` (`BUNDLE_PLUGINS`):
    Enable Bundler's experimental plugin system.
-* `prefer_gems_rb` (`BUNDLE_PREFER_GEMS_RB`)
-   Prefer `gems.rb` to `Gemfile` when Bundler is searching for a Gemfile.
+* `prefer_patch` (BUNDLE_PREFER_PATCH):
+   Prefer updating only to next patch version during updates. Makes `bundle update` calls equivalent to `bundler update --patch`.
 * `print_only_version_number` (`BUNDLE_PRINT_ONLY_VERSION_NUMBER`)
    Print only version number from `bundler --version`.
 * `redirect` (`BUNDLE_REDIRECT`):
@@ -245,6 +244,9 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
 * `shebang` (`BUNDLE_SHEBANG`):
    The program name that should be invoked for generated binstubs. Defaults to
    the ruby install name used to generate the binstub.
+* `silence_deprecations` (`BUNDLE_SILENCE_DEPRECATIONS`):
+   Whether Bundler should silence deprecation warnings for behavior that will
+   be changed in the next major version.
 * `silence_root_warning` (`BUNDLE_SILENCE_ROOT_WARNING`):
    Silence the warning Bundler prints when installing gems as root.
 * `skip_default_git_sources` (`BUNDLE_SKIP_DEFAULT_GIT_SOURCES`):
@@ -300,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
@@ -334,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).
@@ -358,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:
 
@@ -371,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: