mirror of
https://github.com/ruby/ruby.git
synced 2025-08-15 21:49:06 +02:00
[rubygems/rubygems] Moved the REMEMBERING OPTIONS section to be after CONFIGURATION KEYS
Since the remembering options are discouraged, the preferred method should be explained first.
Slight tweak to wording
Fix documentation spec test as per suggested patch
9f082ccf31
This commit is contained in:
Matthew Hively
Hiroshi SHIBATA
parent
f4a5247ce4
commit
21a14ea230
3 changed files with 109 additions and 108 deletions
|
|
@ -42,48 +42,6 @@ Executing \fBbundle config unset \-\-global <name>\fR will delete the configurat
|
|||
Executing \fBbundle config unset \-\-local <name>\fR will delete the configuration only from the local application\.
|
||||
.P
|
||||
Executing bundle with the \fBBUNDLE_IGNORE_CONFIG\fR environment variable set will cause it to ignore all configuration\.
|
||||
.SH "REMEMBERING OPTIONS"
|
||||
Flags passed to \fBbundle install\fR or the Bundler runtime, such as \fB\-\-path foo\fR or \fB\-\-without production\fR, are remembered between commands and saved to your local application's configuration (normally, \fB\./\.bundle/config\fR)\.
|
||||
.P
|
||||
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 \fBbundle config\fR (e\.g\., \fBbundle config set \-\-local path foo\fR)\.
|
||||
.P
|
||||
The options that can be configured are:
|
||||
.TP
|
||||
\fBbin\fR
|
||||
Creates a directory (defaults to \fB~/bin\fR) and place any executables from the gem there\. These executables run in Bundler's context\. If used, you might add this directory to your environment's \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\.
|
||||
.TP
|
||||
\fBdeployment\fR
|
||||
In deployment mode, Bundler will 'roll\-out' the bundle for \fBproduction\fR use\. Please check carefully if you want to have this option enabled in \fBdevelopment\fR or \fBtest\fR environments\.
|
||||
.TP
|
||||
\fBonly\fR
|
||||
A space\-separated list of groups to install only gems of the specified groups\. Please check carefully if you want to install also gems without a group, cause they get put inside \fBdefault\fR group\. For example \fBonly test:default\fR will install all gems specified in test group and without one\.
|
||||
.TP
|
||||
\fBpath\fR
|
||||
The location to install the specified gems to\. This defaults to Rubygems' setting\. Bundler shares this location with Rubygems, \fBgem install \|\.\|\.\|\.\fR will have gem installed there, too\. Therefore, gems installed without a \fB\-\-path \|\.\|\.\|\.\fR setting will show up by calling \fBgem list\fR\. Accordingly, gems installed to other locations will not get listed\.
|
||||
.TP
|
||||
\fBwithout\fR
|
||||
A space\-separated or \fB:\fR\-separated list of groups referencing gems to skip during installation\.
|
||||
.TP
|
||||
\fBwith\fR
|
||||
A space\-separated or \fB:\fR\-separated list of \fBoptional\fR groups referencing gems to include during installation\.
|
||||
.SH "BUILD OPTIONS"
|
||||
You can use \fBbundle config\fR to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem\.
|
||||
.P
|
||||
A very common example, the \fBmysql\fR gem, requires Snow Leopard users to pass configuration flags to \fBgem install\fR to specify where to find the \fBmysql_config\fR executable\.
|
||||
.IP "" 4
|
||||
.nf
|
||||
gem install mysql \-\- \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config
|
||||
.fi
|
||||
.IP "" 0
|
||||
.P
|
||||
Since the specific location of that executable can change from machine to machine, you can specify these flags on a per\-machine basis\.
|
||||
.IP "" 4
|
||||
.nf
|
||||
bundle config set \-\-global build\.mysql \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config
|
||||
.fi
|
||||
.IP "" 0
|
||||
.P
|
||||
After running this command, every time bundler needs to install the \fBmysql\fR gem, it will pass along the flags you specified\.
|
||||
.SH "CONFIGURATION KEYS"
|
||||
Configuration keys in bundler have two forms: the canonical form and the environment variable form\.
|
||||
.P
|
||||
|
|
@ -201,6 +159,48 @@ The following is a list of all configuration keys and their purpose\. You can le
|
|||
.IP "\(bu" 4
|
||||
\fBwithout\fR (\fBBUNDLE_WITHOUT\fR): A space\-separated or \fB:\fR\-separated list of groups whose gems bundler should not install\.
|
||||
.IP "" 0
|
||||
.SH "REMEMBERING OPTIONS"
|
||||
Flags passed to \fBbundle install\fR or the Bundler runtime, such as \fB\-\-path foo\fR or \fB\-\-without production\fR, are remembered between commands and saved to your local application's configuration (normally, \fB\./\.bundle/config\fR)\.
|
||||
.P
|
||||
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 \fBbundle config\fR (e\.g\., \fBbundle config set \-\-local path foo\fR)\.
|
||||
.P
|
||||
The flags that can be configured are:
|
||||
.TP
|
||||
\fB\-\-bin\fR
|
||||
Creates a directory (defaults to \fB~/bin\fR) and place any executables from the gem there\. These executables run in Bundler's context\. If used, you might add this directory to your environment's \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\.
|
||||
.TP
|
||||
\fB\-\-deployment\fR
|
||||
In deployment mode, Bundler will 'roll\-out' the bundle for \fBproduction\fR use\. Please check carefully if you want to have this option enabled in \fBdevelopment\fR or \fBtest\fR environments\.
|
||||
.TP
|
||||
\fB\-\-only\fR
|
||||
A space\-separated list of groups to install only gems of the specified groups\. Please check carefully if you want to install also gems without a group, cause they get put inside \fBdefault\fR group\. For example \fBonly test:default\fR will install all gems specified in test group and without one\.
|
||||
.TP
|
||||
\fB\-\-path\fR
|
||||
The location to install the specified gems to\. This defaults to Rubygems' setting\. Bundler shares this location with Rubygems, \fBgem install \|\.\|\.\|\.\fR will have gem installed there, too\. Therefore, gems installed without a \fB\-\-path \|\.\|\.\|\.\fR setting will show up by calling \fBgem list\fR\. Accordingly, gems installed to other locations will not get listed\.
|
||||
.TP
|
||||
\fB\-\-without\fR
|
||||
A space\-separated or \fB:\fR\-separated list of groups referencing gems to skip during installation\.
|
||||
.TP
|
||||
\fB\-\-with\fR
|
||||
A space\-separated or \fB:\fR\-separated list of \fBoptional\fR groups referencing gems to include during installation\.
|
||||
.SH "BUILD OPTIONS"
|
||||
You can use \fBbundle config\fR to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem\.
|
||||
.P
|
||||
A very common example, the \fBmysql\fR gem, requires Snow Leopard users to pass configuration flags to \fBgem install\fR to specify where to find the \fBmysql_config\fR executable\.
|
||||
.IP "" 4
|
||||
.nf
|
||||
gem install mysql \-\- \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config
|
||||
.fi
|
||||
.IP "" 0
|
||||
.P
|
||||
Since the specific location of that executable can change from machine to machine, you can specify these flags on a per\-machine basis\.
|
||||
.IP "" 4
|
||||
.nf
|
||||
bundle config set \-\-global build\.mysql \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config
|
||||
.fi
|
||||
.IP "" 0
|
||||
.P
|
||||
After running this command, every time bundler needs to install the \fBmysql\fR gem, it will pass along the flags you specified\.
|
||||
.SH "LOCAL GIT REPOS"
|
||||
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:
|
||||
.IP "" 4
|
||||
|
|
|
|||
|
|
@ -52,71 +52,6 @@ only from the local application.
|
|||
Executing bundle with the `BUNDLE_IGNORE_CONFIG` environment variable set will
|
||||
cause it to ignore all configuration.
|
||||
|
||||
## REMEMBERING OPTIONS
|
||||
|
||||
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 --local path foo`).
|
||||
|
||||
The options that can be configured are:
|
||||
|
||||
* `bin`:
|
||||
Creates a directory (defaults to `~/bin`) and place any executables from the
|
||||
gem there. These executables run in Bundler's context. If used, you might add
|
||||
this directory to your environment's `PATH` variable. For instance, if the
|
||||
`rails` gem comes with a `rails` executable, this flag will create a
|
||||
`bin/rails` executable that ensures that all referred dependencies will be
|
||||
resolved using the bundled gems.
|
||||
|
||||
* `deployment`:
|
||||
In deployment mode, Bundler will 'roll-out' the bundle for
|
||||
`production` use. Please check carefully if you want to have this option
|
||||
enabled in `development` or `test` environments.
|
||||
|
||||
* `only`:
|
||||
A space-separated list of groups to install only gems of the specified groups.
|
||||
Please check carefully if you want to install also gems without a group, cause
|
||||
they get put inside `default` group. For example `only test:default` will install
|
||||
all gems specified in test group and without one.
|
||||
|
||||
* `path`:
|
||||
The location to install the specified gems to. This defaults to Rubygems'
|
||||
setting. Bundler shares this location with Rubygems, `gem install ...` will
|
||||
have gem installed there, too. Therefore, gems installed without a
|
||||
`--path ...` setting will show up by calling `gem list`. Accordingly, gems
|
||||
installed to other locations will not get listed.
|
||||
|
||||
* `without`:
|
||||
A space-separated or `:`-separated list of groups referencing gems to skip during
|
||||
installation.
|
||||
|
||||
* `with`:
|
||||
A space-separated or `:`-separated list of **optional** groups referencing gems to
|
||||
include during installation.
|
||||
|
||||
## BUILD OPTIONS
|
||||
|
||||
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.
|
||||
|
||||
gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
|
||||
|
||||
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 set --global 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.
|
||||
|
||||
## CONFIGURATION KEYS
|
||||
|
||||
Configuration keys in bundler have two forms: the canonical form and the
|
||||
|
|
@ -288,6 +223,71 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
|||
* `without` (`BUNDLE_WITHOUT`):
|
||||
A space-separated or `:`-separated list of groups whose gems bundler should not install.
|
||||
|
||||
## REMEMBERING OPTIONS
|
||||
|
||||
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 --local path foo`).
|
||||
|
||||
The flags that can be configured are:
|
||||
|
||||
* `--bin`:
|
||||
Creates a directory (defaults to `~/bin`) and place any executables from the
|
||||
gem there. These executables run in Bundler's context. If used, you might add
|
||||
this directory to your environment's `PATH` variable. For instance, if the
|
||||
`rails` gem comes with a `rails` executable, this flag will create a
|
||||
`bin/rails` executable that ensures that all referred dependencies will be
|
||||
resolved using the bundled gems.
|
||||
|
||||
* `--deployment`:
|
||||
In deployment mode, Bundler will 'roll-out' the bundle for
|
||||
`production` use. Please check carefully if you want to have this option
|
||||
enabled in `development` or `test` environments.
|
||||
|
||||
* `--only`:
|
||||
A space-separated list of groups to install only gems of the specified groups.
|
||||
Please check carefully if you want to install also gems without a group, cause
|
||||
they get put inside `default` group. For example `only test:default` will install
|
||||
all gems specified in test group and without one.
|
||||
|
||||
* `--path`:
|
||||
The location to install the specified gems to. This defaults to Rubygems'
|
||||
setting. Bundler shares this location with Rubygems, `gem install ...` will
|
||||
have gem installed there, too. Therefore, gems installed without a
|
||||
`--path ...` setting will show up by calling `gem list`. Accordingly, gems
|
||||
installed to other locations will not get listed.
|
||||
|
||||
* `--without`:
|
||||
A space-separated or `:`-separated list of groups referencing gems to skip during
|
||||
installation.
|
||||
|
||||
* `--with`:
|
||||
A space-separated or `:`-separated list of **optional** groups referencing gems to
|
||||
include during installation.
|
||||
|
||||
## BUILD OPTIONS
|
||||
|
||||
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.
|
||||
|
||||
gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
|
||||
|
||||
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 set --global 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.
|
||||
|
||||
## LOCAL GIT REPOS
|
||||
|
||||
Bundler also allows you to work against a git repository locally
|
||||
|
|
|
|||
|
|
@ -165,7 +165,8 @@ RSpec.describe "The library itself" do
|
|||
line.scan(/Bundler\.settings\[:#{key_pattern}\]/).flatten.each {|s| all_settings[s] << "referenced at `#{filename}:#{number.succ}`" }
|
||||
end
|
||||
end
|
||||
documented_settings = File.read("lib/bundler/man/bundle-config.1.ronn")[/LIST OF AVAILABLE KEYS.*/m].scan(/^\* `#{key_pattern}`/).flatten
|
||||
settings_section = File.read("lib/bundler/man/bundle-config.1.ronn").split(/^## /).find {|section| section.start_with?("LIST OF AVAILABLE KEYS") }
|
||||
documented_settings = settings_section.scan(/^\* `#{key_pattern}`/).flatten
|
||||
|
||||
documented_settings.each do |s|
|
||||
all_settings.delete(s)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue