1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[rubygems/rubygems] Update bundler documentation to reflect bundle config scope changes

Browse Source 
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
This commit is contained in:
James Hill 2022-03-31 11:58:39 +11:00 committed by git
parent d8189ed23f
commit 834c3b3545
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
lib/bundler/man/bundle-config.1
View File

@ -36,15 +36,15 @@ 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\. Executing \fBbundle config get <name>\fR will print the value of that configuration setting, and where it was set\.
. .
.P .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\.
. .
.P .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 \-\-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 .P
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\. Executing \fBbundle config unset <name>\fR will delete the configuration in both local and global sources\.
. .
.P .P

14
lib/bundler/man/bundle-config.1.ronn
View File

@ -23,18 +23,20 @@ was set.
Executing `bundle config get <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. setting, and where it was set.
Executing `bundle config set <name> <value>` will set that configuration to the Executing `bundle config set <name> <value>` defaults to setting `local`
value specified for all bundles executed as the current user. The configuration configuration if executing from within a local application, otherwise it will
will be stored in `~/.bundle/config`. If <name> already is set, <name> will be set `global` configuration. See `--local` and `--global` options below.
overridden and user will be warned.
Executing `bundle config set --global <name> <value>` works the same as above.
Executing `bundle config set --local <name> <value>` will set that configuration Executing `bundle config set --local <name> <value>` will set that configuration
in the directory for the local application. The configuration will be stored in 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 `<project_root>/.bundle/config`. If `BUNDLE_APP_CONFIG` is set, the configuration
will be stored in `$BUNDLE_APP_CONFIG/config`. 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 Executing `bundle config unset <name>` will delete the configuration in both
local and global sources. local and global sources.