diff options
author | James Hill <james.f.hill@gmail.com> | 2022-03-31 11:58:39 +1100 |
---|---|---|
committer | git <svn-admin@ruby-lang.org> | 2022-03-31 20:00:10 +0900 |
commit | 834c3b35455ed50c7ad879b3e2f807eaa9b0a328 (patch) | |
tree | a878808a0750638a26e3b071e7f8756ccbf59916 /lib/bundler | |
parent | d8189ed23f02dd197453279aeee9be1785337d4f (diff) | |
download | ruby-834c3b35455ed50c7ad879b3e2f807eaa9b0a328.tar.gz |
[rubygems/rubygems] Update bundler documentation to reflect bundle config scope changes
In https://github.com/rubygems/rubygems/pull/4152 `bundle config` was changed
to default to local scope (instead of global) if the command was executed
from inside an application directory.
Updated documentation reflects this change.
https://github.com/rubygems/rubygems/commit/d92d42cae5
Diffstat (limited to 'lib/bundler')
-rw-r--r-- | lib/bundler/man/bundle-config.1 | 6 | ||||
-rw-r--r-- | lib/bundler/man/bundle-config.1.ronn | 14 |
2 files changed, 11 insertions, 9 deletions
diff --git a/lib/bundler/man/bundle-config.1 b/lib/bundler/man/bundle-config.1 index c84a2b106e..d657910e83 100644 --- a/lib/bundler/man/bundle-config.1 +++ b/lib/bundler/man/bundle-config.1 @@ -36,13 +36,13 @@ Executing \fBbundle config list\fR with will print a list of all bundler configu Executing \fBbundle config get <name>\fR will print the value of that configuration setting, and where it was set\. . .P -Executing \fBbundle config set <name> <value>\fR will set that configuration to the value specified for all bundles executed as the current user\. The configuration will be stored in \fB~/\.bundle/config\fR\. If \fIname\fR already is set, \fIname\fR will be overridden and user will be warned\. +Executing \fBbundle config set <name> <value>\fR defaults to setting \fBlocal\fR configuration if executing from within a local application, otherwise it will set \fBglobal\fR configuration\. See \fB\-\-local\fR and \fB\-\-global\fR options below\. . .P -Executing \fBbundle config set \-\-global <name> <value>\fR works the same as above\. +Executing \fBbundle config set \-\-local <name> <value>\fR will set that configuration in the directory for the local application\. The configuration will be stored in \fB<project_root>/\.bundle/config\fR\. If \fBBUNDLE_APP_CONFIG\fR is set, the configuration will be stored in \fB$BUNDLE_APP_CONFIG/config\fR\. . .P -Executing \fBbundle config set \-\-local <name> <value>\fR will set that configuration in the directory for the local application\. The configuration will be stored in \fB<project_root>/\.bundle/config\fR\. If \fBBUNDLE_APP_CONFIG\fR is set, the configuration will be stored in \fB$BUNDLE_APP_CONFIG/config\fR\. +Executing \fBbundle config set \-\-global <name> <value>\fR will set that configuration to the value specified for all bundles executed as the current user\. The configuration will be stored in \fB~/\.bundle/config\fR\. If \fIname\fR already is set, \fIname\fR will be overridden and user will be warned\. . .P Executing \fBbundle config unset <name>\fR will delete the configuration in both local and global sources\. diff --git a/lib/bundler/man/bundle-config.1.ronn b/lib/bundler/man/bundle-config.1.ronn index e0533e05be..7d1cb271a9 100644 --- a/lib/bundler/man/bundle-config.1.ronn +++ b/lib/bundler/man/bundle-config.1.ronn @@ -23,18 +23,20 @@ was set. Executing `bundle config get <name>` will print the value of that configuration setting, and where it was set. -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 set --global <name> <value>` works the same as above. +Executing `bundle config set <name> <value>` defaults to setting `local` +configuration if executing from within a local application, otherwise it will +set `global` configuration. See `--local` and `--global` options below. Executing `bundle config set --local <name> <value>` will set that configuration in the directory for the local application. The configuration will be stored in `<project_root>/.bundle/config`. If `BUNDLE_APP_CONFIG` is set, the configuration will be stored in `$BUNDLE_APP_CONFIG/config`. +Executing `bundle config set --global <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 unset <name>` will delete the configuration in both local and global sources. |