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

[rubygems/rubygems] Normalize CLI flag documentation and make sure all flags are documented

Browse Source 
https://github.com/rubygems/rubygems/commit/20a834818b
This commit is contained in:
David Rodríguez 2024-12-10 19:34:18 +01:00 committed by git
parent e1fcf20ea1
commit cfb7213882
28 changed files with 149 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
lib/bundler/man/bundle-add.1
View File

@ -9,31 +9,31 @@
Adds the named gem to the [\fBGemfile(5)\fR][Gemfile(5)] and run \fBbundle install\fR\. \fBbundle install\fR can be avoided by using the flag \fB\-\-skip\-install\fR\.
.SH "OPTIONS"
.TP
\fB\-\-version\fR, \fB\-v\fR
\fB\-\-version=VERSION\fR, \fB\-v=VERSION\fR
Specify version requirements(s) for the added gem\.
.TP
\fB\-\-group\fR, \fB\-g\fR
\fB\-\-group=GROUP\fR, \fB\-g=GROUP\fR
Specify the group(s) for the added gem\. Multiple groups should be separated by commas\.
.TP
\fB\-\-source\fR, \fB\-s\fR
\fB\-\-source=SOURCE\fR, \fB\-s=SOURCE\fR
Specify the source for the added gem\.
.TP
\fB\-\-require\fR, \fB\-r\fR
\fB\-\-require=REQUIRE\fR, \fB\-r=REQUIRE\fR
Adds require path to gem\. Provide false, or a path as a string\.
.TP
\fB\-\-path\fR
\fB\-\-path=PATH\fR
Specify the file system path for the added gem\.
.TP
\fB\-\-git\fR
\fB\-\-git=GIT\fR
Specify the git source for the added gem\.
.TP
\fB\-\-github\fR
\fB\-\-github=GITHUB\fR
Specify the github source for the added gem\.
.TP
\fB\-\-branch\fR
\fB\-\-branch=BRANCH\fR
Specify the git branch for the added gem\.
.TP
\fB\-\-ref\fR
\fB\-\-ref=REF\fR
Specify the git ref for the added gem\.
.TP
\fB\-\-glob=GLOB\fR

18
lib/bundler/man/bundle-add.1.ronn
View File

@ -14,31 +14,31 @@ Adds the named gem to the [`Gemfile(5)`][Gemfile(5)] and run `bundle install`.
## OPTIONS
* `--version`, `-v`:
* `--version=VERSION`, `-v=VERSION`:
Specify version requirements(s) for the added gem.
* `--group`, `-g`:
* `--group=GROUP`, `-g=GROUP`:
Specify the group(s) for the added gem. Multiple groups should be separated by commas.
* `--source`, `-s`:
* `--source=SOURCE`, `-s=SOURCE`:
Specify the source for the added gem.
* `--require`, `-r`:
* `--require=REQUIRE`, `-r=REQUIRE`:
Adds require path to gem. Provide false, or a path as a string.
* `--path`:
* `--path=PATH`:
Specify the file system path for the added gem.
* `--git`:
* `--git=GIT`:
Specify the git source for the added gem.
* `--github`:
* `--github=GITHUB`:
Specify the github source for the added gem.
* `--branch`:
* `--branch=BRANCH`:
Specify the git branch for the added gem.
* `--ref`:
* `--ref=REF`:
Specify the git ref for the added gem.
* `--glob=GLOB`:

4
lib/bundler/man/bundle-binstubs.1
View File

@ -16,13 +16,13 @@ This command generates binstubs for executables in \fBGEM_NAME\fR\. Binstubs are
\fB\-\-force\fR
Overwrite existing binstubs if they exist\.
.TP
\fB\-\-path\fR
\fB\-\-path[=PATH]\fR
The location to install the specified binstubs to\. This defaults to \fBbin\fR\.
.TP
\fB\-\-standalone\fR
Makes binstubs that can work without depending on Rubygems or Bundler at runtime\.
.TP
\fB\-\-shebang\fR
\fB\-\-shebang=SHEBANG\fR
Specify a different shebang executable name than the default (default 'ruby')
.TP
\fB\-\-all\fR

4
lib/bundler/man/bundle-binstubs.1.ronn
View File

@ -27,14 +27,14 @@ Calling binstubs with [GEM [GEM]] will create binstubs for all given gems.
* `--force`:
Overwrite existing binstubs if they exist.
* `--path`:
* `--path[=PATH]`:
The location to install the specified binstubs to. This defaults to `bin`.
* `--standalone`:
Makes binstubs that can work without depending on Rubygems or Bundler at
runtime.
* `--shebang`:
* `--shebang=SHEBANG`:
Specify a different shebang executable name than the default (default 'ruby')
* `--all`:

4
lib/bundler/man/bundle-check.1
View File

@ -16,9 +16,9 @@ If the lockfile needs to be updated then it will be resolved using the gems inst
\fB\-\-dry\-run\fR
Locks the [\fBGemfile(5)\fR][Gemfile(5)] before running the command\.
.TP
\fB\-\-gemfile\fR
\fB\-\-gemfile=GEMFILE\fR
Use the specified gemfile instead of the [\fBGemfile(5)\fR][Gemfile(5)]\.
.TP
\fB\-\-path\fR
\fB\-\-path=PATH\fR
Specify a different path than the system default (\fB$BUNDLE_PATH\fR or \fB$GEM_HOME\fR)\. Bundler will remember this value for future installs on this machine\.

4
lib/bundler/man/bundle-check.1.ronn
View File

@ -23,9 +23,9 @@ installed on the local machine, if they satisfy the requirements.
* `--dry-run`:
Locks the [`Gemfile(5)`][Gemfile(5)] before running the command.
* `--gemfile`:
* `--gemfile=GEMFILE`:
Use the specified gemfile instead of the [`Gemfile(5)`][Gemfile(5)].
* `--path`:
* `--path=PATH`:
Specify a different path than the system default (`$BUNDLE_PATH` or `$GEM_HOME`).
Bundler will remember this value for future installs on this machine.

2
lib/bundler/man/bundle-doctor.1
View File

@ -25,6 +25,6 @@ Missing dependencies
\fB\-\-quiet\fR
Only output warnings and errors\.
.TP
\fB\-\-gemfile=<gemfile>\fR
\fB\-\-gemfile=GEMFILE\fR
The location of the Gemfile(5) which Bundler should use\. This defaults to a Gemfile(5) in the current working directory\. In general, Bundler will assume that the location of the Gemfile(5) is also the project's root and will try to find \fBGemfile\.lock\fR and \fBvendor/cache\fR relative to this location\.

2
lib/bundler/man/bundle-doctor.1.ronn
View File

@ -25,7 +25,7 @@ Examples of common problems caught by bundle-doctor include:
* `--quiet`:
Only output warnings and errors.
* `--gemfile=<gemfile>`:
* `--gemfile=GEMFILE`:
The location of the Gemfile(5) which Bundler should use. This defaults
to a Gemfile(5) in the current working directory. In general, Bundler
will assume that the location of the Gemfile(5) is also the project's

2
lib/bundler/man/bundle-fund.1
View File

@ -9,7 +9,7 @@
\fBbundle fund\fR lists information about gems seeking funding assistance\.
.SH "OPTIONS"
.TP
\fB\-g\fR, \fB\-\-group=GROUP\fR
\fB\-\-group=<list>\fR, \fB\-g=<list>\fR
Fetch funding information for a specific group\.
.SH "EXAMPLES"
.nf

2
lib/bundler/man/bundle-fund.1.ronn
View File

@ -11,7 +11,7 @@ bundle-fund(1) -- Lists information about gems seeking funding assistance
## OPTIONS
* `-g`, `--group=GROUP`:
* `--group=<list>`, `-g=<list>`:
Fetch funding information for a specific group.
## EXAMPLES

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

@ -20,7 +20,7 @@ The generated project skeleton can be customized with OPTIONS, as explained belo
.IP "" 0
.SH "OPTIONS"
.IP "\(bu" 4
\fB\-\-exe\fR or \fB\-b\fR or \fB\-\-bin\fR: Specify that Bundler should create a binary executable (as \fBexe/GEM_NAME\fR) in the generated rubygem project\. This binary will also be added to the \fBGEM_NAME\.gemspec\fR manifest\. This behavior is disabled by default\.
\fB\-\-exe\fR, \fB\-\-bin\fR, \fB\-b\fR: Specify that Bundler should create a binary executable (as \fBexe/GEM_NAME\fR) in the generated rubygem project\. This binary will also be added to the \fBGEM_NAME\.gemspec\fR manifest\. This behavior is disabled by default\.
.IP "\(bu" 4
\fB\-\-no\-exe\fR: Do not create a binary (overrides \fB\-\-exe\fR specified in the global config)\.
.IP "\(bu" 4
@ -32,7 +32,7 @@ The generated project skeleton can be customized with OPTIONS, as explained belo
.IP "\(bu" 4
\fB\-\-no\-changelog\fR: Do not create a \fBCHANGELOG\.md\fR (overrides \fB\-\-changelog\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-\-ext=c\fR, \fB\-\-ext=rust\fR Add boilerplate for C or Rust (currently magnus \fIhttps://docs\.rs/magnus\fR based) extension code to the generated project\. This behavior is disabled by default\.
\fB\-\-ext=c\fR, \fB\-\-ext=rust\fR: Add boilerplate for C or Rust (currently magnus \fIhttps://docs\.rs/magnus\fR based) extension code to the generated project\. This behavior is disabled by default\.
.IP "\(bu" 4
\fB\-\-no\-ext\fR: Do not add extension code (overrides \fB\-\-ext\fR specified in the global config)\.
.IP "\(bu" 4
@ -56,7 +56,7 @@ When Bundler is unconfigured, an interactive prompt will be displayed and the an
.IP "\(bu" 4
\fB\-\-changelog\fR: Generate changelog file\. Set a default with \fBbundle config set \-\-global gem\.changelog true\fR\.
.IP "\(bu" 4
\fB\-\-ci\fR, \fB\-\-ci=github\fR, \fB\-\-ci=gitlab\fR, \fB\-\-ci=circle\fR: Specify the continuous integration service that Bundler should use when generating the project\. Acceptable values are \fBgithub\fR, \fBgitlab\fR and \fBcircle\fR\. A configuration file will be generated in the project directory\. Given no option is specified:
\fB\-\-ci\fR, \fB\-\-ci=circle\fR, \fB\-\-ci=github\fR, \fB\-\-ci=gitlab\fR: Specify the continuous integration service that Bundler should use when generating the project\. Acceptable values are \fBgithub\fR, \fBgitlab\fR and \fBcircle\fR\. A configuration file will be generated in the project directory\. Given no option is specified:
.IP
When Bundler is configured to generate CI files, this defaults to Bundler's global config setting \fBgem\.ci\fR\.
.IP
@ -78,7 +78,7 @@ When Bundler is unconfigured, an interactive prompt will be displayed and the an
.IP "\(bu" 4
\fB\-\-rubocop\fR: Add rubocop to the generated Rakefile and gemspec\. Set a default with \fBbundle config set \-\-global gem\.rubocop true\fR\.
.IP "\(bu" 4
\fB\-e\fR, \fB\-\-edit[=EDITOR]\fR: Open the resulting GEM_NAME\.gemspec in EDITOR, or the default editor if not specified\. The default is \fB$BUNDLER_EDITOR\fR, \fB$VISUAL\fR, or \fB$EDITOR\fR\.
\fB\-\-edit=EDIT\fR, \fB\-e=EDIT\fR: Open the resulting GEM_NAME\.gemspec in EDIT, or the default editor if not specified\. The default is \fB$BUNDLER_EDITOR\fR, \fB$VISUAL\fR, or \fB$EDITOR\fR\.
.IP "" 0
.SH "SEE ALSO"
.IP "\(bu" 4

10
lib/bundler/man/bundle-gem.1.ronn
View File

@ -24,7 +24,7 @@ configuration file using the following names:
## OPTIONS
* `--exe` or `-b` or `--bin`:
* `--exe`, `--bin`, `-b`:
Specify that Bundler should create a binary executable (as `exe/GEM_NAME`)
in the generated rubygem project. This binary will also be added to the
`GEM_NAME.gemspec` manifest. This behavior is disabled by default.
@ -50,7 +50,7 @@ configuration file using the following names:
Do not create a `CHANGELOG.md` (overrides `--changelog` specified in the
global config).
* `--ext=c`, `--ext=rust`
* `--ext=c`, `--ext=rust`:
Add boilerplate for C or Rust (currently [magnus](https://docs.rs/magnus) based) extension code to the generated project. This behavior
is disabled by default.
@ -98,7 +98,7 @@ configuration file using the following names:
* `--changelog`:
Generate changelog file. Set a default with `bundle config set --global gem.changelog true`.
* `--ci`, `--ci=github`, `--ci=gitlab`, `--ci=circle`:
* `--ci`, `--ci=circle`, `--ci=github`, `--ci=gitlab`:
Specify the continuous integration service that Bundler should use when
generating the project. Acceptable values are `github`, `gitlab`
and `circle`. A configuration file will be generated in the project directory.
@ -140,8 +140,8 @@ configuration file using the following names:
* `--rubocop`:
Add rubocop to the generated Rakefile and gemspec. Set a default with `bundle config set --global gem.rubocop true`.
* `-e`, `--edit[=EDITOR]`:
Open the resulting GEM_NAME.gemspec in EDITOR, or the default editor if not
* `--edit=EDIT`, `-e=EDIT`:
Open the resulting GEM_NAME.gemspec in EDIT, or the default editor if not
specified. The default is `$BUNDLER_EDITOR`, `$VISUAL`, or `$EDITOR`.
## SEE ALSO

4
lib/bundler/man/bundle-init.1
View File

@ -9,10 +9,10 @@
Init generates a default [\fBGemfile(5)\fR][Gemfile(5)] in the current working directory\. When adding a [\fBGemfile(5)\fR][Gemfile(5)] to a gem with a gemspec, the \fB\-\-gemspec\fR option will automatically add each dependency listed in the gemspec file to the newly created [\fBGemfile(5)\fR][Gemfile(5)]\.
.SH "OPTIONS"
.TP
\fB\-\-gemspec\fR
\fB\-\-gemspec=GEMSPEC\fR
Use the specified \.gemspec to create the [\fBGemfile(5)\fR][Gemfile(5)]
.TP
\fB\-\-gemfile\fR
\fB\-\-gemfile=GEMFILE\fR
Use the specified name for the gemfile instead of \fBGemfile\fR
.SH "FILES"
Included in the default [\fBGemfile(5)\fR][Gemfile(5)] generated is the line \fB# frozen_string_literal: true\fR\. This is a magic comment supported for the first time in Ruby 2\.3\. The presence of this line results in all string literals in the file being implicitly frozen\.

4
lib/bundler/man/bundle-init.1.ronn
View File

@ -14,10 +14,10 @@ created [`Gemfile(5)`][Gemfile(5)].
## OPTIONS
* `--gemspec`:
* `--gemspec=GEMSPEC`:
Use the specified .gemspec to create the [`Gemfile(5)`][Gemfile(5)]
* `--gemfile`:
* `--gemfile=GEMFILE`:
Use the specified name for the gemfile instead of `Gemfile`
## FILES

20
lib/bundler/man/bundle-install.1
View File

@ -4,7 +4,7 @@
.SH "NAME"
\fBbundle\-install\fR \- Install the dependencies specified in your Gemfile
.SH "SYNOPSIS"
\fBbundle install\fR [\-\-binstubs[=DIRECTORY]] [\-\-clean] [\-\-deployment] [\-\-frozen] [\-\-full\-index] [\-\-gemfile=GEMFILE] [\-\-jobs=NUMBER] [\-\-local] [\-\-no\-cache] [\-\-no\-prune] [\-\-path PATH] [\-\-prefer\-local] [\-\-quiet] [\-\-redownload] [\-\-retry=NUMBER] [\-\-shebang] [\-\-standalone[=GROUP[ GROUP\|\.\|\.\|\.]]] [\-\-system] [\-\-trust\-policy=POLICY] [\-\-target\-rbconfig=TARGET\-RBCONFIG] [\-\-with=GROUP[ GROUP\|\.\|\.\|\.]] [\-\-without=GROUP[ GROUP\|\.\|\.\|\.]]
\fBbundle install\fR [\-\-binstubs[=DIRECTORY]] [\-\-clean] [\-\-deployment] [\-\-frozen] [\-\-full\-index] [\-\-gemfile=GEMFILE] [\-\-jobs=NUMBER] [\-\-local] [\-\-no\-cache] [\-\-no\-prune] [\-\-path PATH] [\-\-prefer\-local] [\-\-quiet] [\-\-redownload] [\-\-retry=NUMBER] [\-\-shebang=SHEBANG] [\-\-standalone[=GROUP[ GROUP\|\.\|\.\|\.]]] [\-\-system] [\-\-trust\-policy=TRUST\-POLICY] [\-\-target\-rbconfig=TARGET\-RBCONFIG] [\-\-with=GROUP[ GROUP\|\.\|\.\|\.]] [\-\-without=GROUP[ GROUP\|\.\|\.\|\.]]
.SH "DESCRIPTION"
Install the gems specified in your Gemfile(5)\. If this is the first time you run bundle install (and a \fBGemfile\.lock\fR does not exist), Bundler will fetch all remote sources, resolve dependencies and install all needed gems\.
.P
@ -14,10 +14,10 @@ If a \fBGemfile\.lock\fR does exist, and you have updated your Gemfile(5), Bundl
.SH "OPTIONS"
The \fB\-\-clean\fR, \fB\-\-deployment\fR, \fB\-\-frozen\fR, \fB\-\-no\-prune\fR, \fB\-\-path\fR, \fB\-\-shebang\fR, \fB\-\-system\fR, \fB\-\-without\fR and \fB\-\-with\fR options are deprecated because they only make sense if they are applied to every subsequent \fBbundle install\fR run automatically and that requires \fBbundler\fR to silently remember them\. Since \fBbundler\fR will no longer remember CLI flags in future versions, \fBbundle config\fR (see bundle\-config(1)) should be used to apply them permanently\.
.TP
\fB\-\-binstubs[=<directory>]\fR
\fB\-\-binstubs[=BINSTUBS]\fR
Binstubs are scripts that wrap around executables\. Bundler creates a small Ruby file (a binstub) that loads Bundler, runs the command, and puts it in \fBbin/\fR\. This lets you link the binstub inside of an application to the exact gem version the application needs\.
.IP
Creates a directory (defaults to \fB~/bin\fR) and places 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\.
Creates a directory (defaults to \fB~/bin\fR when the option is used without a value, or to the given \fB<BINSTUBS>\fR directory otherwise) and places 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\-\-clean\fR
On finishing the installation Bundler is going to remove any gems not present in the current Gemfile(5)\. Don't worry, gems currently in use will not be removed\.
@ -29,7 +29,7 @@ In \fIdeployment mode\fR, Bundler will 'roll\-out' the bundle for production or
.IP
This option is deprecated in favor of the \fBdeployment\fR setting\.
.TP
\fB\-\-redownload\fR
\fB\-\-redownload\fR, \fB\-\-force\fR
Force download every gem, even if the required versions are already available locally\.
.TP
\fB\-\-frozen\fR
@ -40,10 +40,10 @@ This option is deprecated in favor of the \fBfrozen\fR setting\.
\fB\-\-full\-index\fR
Bundler will not call Rubygems' API endpoint (default) but download and cache a (currently big) index file of all gems\. Performance can be improved for large bundles that seldom change by enabling this option\.
.TP
\fB\-\-gemfile=<gemfile>\fR
\fB\-\-gemfile=GEMFILE\fR
The location of the Gemfile(5) which Bundler should use\. This defaults to a Gemfile(5) in the current working directory\. In general, Bundler will assume that the location of the Gemfile(5) is also the project's root and will try to find \fBGemfile\.lock\fR and \fBvendor/cache\fR relative to this location\.
.TP
\fB\-\-jobs=[<number>]\fR, \fB\-j[<number>]\fR
\fB\-\-jobs=<number>\fR, \fB\-j=<number>\fR
The maximum number of parallel download and install jobs\. The default is the number of available processors\.
.TP
\fB\-\-local\fR
@ -60,7 +60,7 @@ Don't remove stale gems from the cache when the installation finishes\.
.IP
This option is deprecated in favor of the \fBno_prune\fR setting\.
.TP
\fB\-\-path=<path>\fR
\fB\-\-path=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\.
.IP
This option is deprecated in favor of the \fBpath\fR setting\.
@ -71,20 +71,20 @@ Do not print progress information to the standard output\.
\fB\-\-retry=[<number>]\fR
Retry failed network or git requests for \fInumber\fR times\.
.TP
\fB\-\-shebang=<ruby\-executable>\fR
\fB\-\-shebang=SHEBANG\fR
Uses the specified ruby executable (usually \fBruby\fR) to execute the scripts created with \fB\-\-binstubs\fR\. In addition, if you use \fB\-\-binstubs\fR together with \fB\-\-shebang jruby\fR these executables will be changed to execute \fBjruby\fR instead\.
.IP
This option is deprecated in favor of the \fBshebang\fR setting\.
.TP
\fB\-\-standalone[=<list>]\fR
Makes a bundle that can work without depending on Rubygems or Bundler at runtime\. A space separated list of groups to install has to be specified\. Bundler creates a directory named \fBbundle\fR and installs the bundle there\. It also generates a \fBbundle/bundler/setup\.rb\fR file to replace Bundler's own setup in the manner required\. Using this option implicitly sets \fBpath\fR, which is a [remembered option][REMEMBERED OPTIONS]\.
Makes a bundle that can work without depending on Rubygems or Bundler at runtime\. A space separated list of groups to install can be specified\. Bundler creates a directory named \fBbundle\fR and installs the bundle there\. It also generates a \fBbundle/bundler/setup\.rb\fR file to replace Bundler's own setup in the manner required\. Using this option implicitly sets \fBpath\fR, which is a [remembered option][REMEMBERED OPTIONS]\.
.TP
\fB\-\-system\fR
Installs the gems specified in the bundle to the system's Rubygems location\. This overrides any previous configuration of \fB\-\-path\fR\.
.IP
This option is deprecated in favor of the \fBsystem\fR setting\.
.TP
\fB\-\-trust\-policy=[<policy>]\fR
\fB\-\-trust\-policy=TRUST\-POLICY\fR
Apply the Rubygems security policy \fIpolicy\fR, where policy is one of \fBHighSecurity\fR, \fBMediumSecurity\fR, \fBLowSecurity\fR, \fBAlmostNoSecurity\fR, or \fBNoSecurity\fR\. For more details, please see the Rubygems signing documentation linked below in \fISEE ALSO\fR\.
.TP
\fB\-\-target\-rbconfig=TARGET\-RBCONFIG\fR

33
lib/bundler/man/bundle-install.1.ronn
View File

@ -18,10 +18,10 @@ bundle-install(1) -- Install the dependencies specified in your Gemfile
[--quiet]
[--redownload]
[--retry=NUMBER]
[--shebang]
[--shebang=SHEBANG]
[--standalone[=GROUP[ GROUP...]]]
[--system]
[--trust-policy=POLICY]
[--trust-policy=TRUST-POLICY]
[--target-rbconfig=TARGET-RBCONFIG]
[--with=GROUP[ GROUP...]]
[--without=GROUP[ GROUP...]]
@ -52,18 +52,19 @@ automatically and that requires `bundler` to silently remember them. Since
`bundler` will no longer remember CLI flags in future versions, `bundle config`
(see bundle-config(1)) should be used to apply them permanently.
* `--binstubs[=<directory>]`:
* `--binstubs[=BINSTUBS]`:
Binstubs are scripts that wrap around executables. Bundler creates a small Ruby
file (a binstub) that loads Bundler, runs the command, and puts it in `bin/`.
This lets you link the binstub inside of an application to the exact gem
version the application needs.
Creates a directory (defaults to `~/bin`) and places 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.
Creates a directory (defaults to `~/bin` when the option is used without a
value, or to the given `<BINSTUBS>` directory otherwise) and places 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.
* `--clean`:
On finishing the installation Bundler is going to remove any gems not present
@ -79,7 +80,7 @@ automatically and that requires `bundler` to silently remember them. Since
This option is deprecated in favor of the `deployment` setting.
* `--redownload`:
* `--redownload`, `--force`:
Force download every gem, even if the required versions are already available
locally.
@ -94,14 +95,14 @@ automatically and that requires `bundler` to silently remember them. Since
a (currently big) index file of all gems. Performance can be improved for
large bundles that seldom change by enabling this option.
* `--gemfile=<gemfile>`:
* `--gemfile=GEMFILE`:
The location of the Gemfile(5) which Bundler should use. This defaults
to a Gemfile(5) in the current working directory. In general, Bundler
will assume that the location of the Gemfile(5) is also the project's
root and will try to find `Gemfile.lock` and `vendor/cache` relative
to this location.
* `--jobs=[<number>]`, `-j[<number>]`:
* `--jobs=<number>`, `-j=<number>`:
The maximum number of parallel download and install jobs. The default is the
number of available processors.
@ -127,7 +128,7 @@ automatically and that requires `bundler` to silently remember them. Since
This option is deprecated in favor of the `no_prune` setting.
* `--path=<path>`:
* `--path=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
@ -142,7 +143,7 @@ automatically and that requires `bundler` to silently remember them. Since
* `--retry=[<number>]`:
Retry failed network or git requests for <number> times.
* `--shebang=<ruby-executable>`:
* `--shebang=SHEBANG`:
Uses the specified ruby executable (usually `ruby`) to execute the scripts
created with `--binstubs`. In addition, if you use `--binstubs` together with
`--shebang jruby` these executables will be changed to execute `jruby`
@ -152,7 +153,7 @@ automatically and that requires `bundler` to silently remember them. Since
* `--standalone[=<list>]`:
Makes a bundle that can work without depending on Rubygems or Bundler at
runtime. A space separated list of groups to install has to be specified.
runtime. A space separated list of groups to install can be specified.
Bundler creates a directory named `bundle` and installs the bundle there. It
also generates a `bundle/bundler/setup.rb` file to replace Bundler's own setup
in the manner required. Using this option implicitly sets `path`, which is a
@ -164,7 +165,7 @@ automatically and that requires `bundler` to silently remember them. Since
This option is deprecated in favor of the `system` setting.
* `--trust-policy=[<policy>]`:
* `--trust-policy=TRUST-POLICY`:
Apply the Rubygems security policy <policy>, where policy is one of
`HighSecurity`, `MediumSecurity`, `LowSecurity`, `AlmostNoSecurity`, or
`NoSecurity`. For more details, please see the Rubygems signing documentation

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

@ -9,7 +9,7 @@
Lock the gems specified in Gemfile\.
.SH "OPTIONS"
.TP
\fB\-\-update=<*gems>\fR
\fB\-\-update[=<list>]\fR
Ignores the existing lockfile\. Resolve then updates lockfile\. Taking a list of gems or updating all gems if no list is given\.
.TP
\fB\-\-bundler[=BUNDLER]\fR
@ -21,7 +21,7 @@ Do not attempt to connect to \fBrubygems\.org\fR\. Instead, Bundler will use the
\fB\-\-print\fR
Prints the lockfile to STDOUT instead of writing to the file system\.
.TP
\fB\-\-lockfile=<path>\fR
\fB\-\-lockfile=LOCKFILE\fR
The path where the lockfile should be written to\.
.TP
\fB\-\-full\-index\fR
@ -33,10 +33,10 @@ Use the specified gemfile instead of [\fBGemfile(5)\fR][Gemfile(5)]\.
\fB\-\-add\-checksums\fR
Add checksums to the lockfile\.
.TP
\fB\-\-add\-platform\fR
\fB\-\-add\-platform=<list>\fR
Add a new platform to the lockfile, re\-resolving for the addition of that platform\.
.TP
\fB\-\-remove\-platform\fR
\fB\-\-remove\-platform=<list>\fR
Remove a platform from the lockfile\.
.TP
\fB\-\-normalize\-platforms\fR

8
lib/bundler/man/bundle-lock.1.ronn
View File

@ -27,7 +27,7 @@ Lock the gems specified in Gemfile.
## OPTIONS
* `--update=<*gems>`:
* `--update[=<list>]`:
Ignores the existing lockfile. Resolve then updates lockfile. Taking a list
of gems or updating all gems if no list is given.
@ -44,7 +44,7 @@ Lock the gems specified in Gemfile.
* `--print`:
Prints the lockfile to STDOUT instead of writing to the file system.
* `--lockfile=<path>`:
* `--lockfile=LOCKFILE`:
The path where the lockfile should be written to.
* `--full-index`:
@ -56,11 +56,11 @@ Lock the gems specified in Gemfile.
* `--add-checksums`:
Add checksums to the lockfile.
* `--add-platform`:
* `--add-platform=<list>`:
Add a new platform to the lockfile, re-resolving for the addition of that
platform.
* `--remove-platform`:
* `--remove-platform=<list>`:
Remove a platform from the lockfile.
* `--normalize-platforms`:

2
lib/bundler/man/bundle-open.1
View File

@ -27,6 +27,6 @@ bundle open 'rack' \-\-path 'README\.md'
Will open the README\.md file of the 'rack' gem source in your bundle\.
.SH "OPTIONS"
.TP
\fB\-\-path\fR
\fB\-\-path[=PATH]\fR
Specify GEM source relative path to open\.

2
lib/bundler/man/bundle-open.1.ronn
View File

@ -24,5 +24,5 @@ Will open the README.md file of the 'rack' gem source in your bundle.
## OPTIONS
* `--path`:
* `--path[=PATH]`:
Specify GEM source relative path to open.

4
lib/bundler/man/bundle-outdated.1
View File

@ -15,7 +15,7 @@ Do not attempt to fetch gems remotely and use the gem cache instead\.
\fB\-\-pre\fR
Check for newer pre\-release gems\.
.TP
\fB\-\-source\fR
\fB\-\-source=<list>\fR
Check against a specific source\.
.TP
\fB\-\-filter\-strict\fR, \fB\-\-strict\fR
@ -27,7 +27,7 @@ Strict conservative resolution, do not allow any gem to be updated past latest \
\fB\-\-parseable\fR, \fB\-\-porcelain\fR
Use minimal formatting for more parseable output\.
.TP
\fB\-\-group\fR
\fB\-\-group=GROUP\fR
List gems from a specific group\.
.TP
\fB\-\-groups\fR

4
lib/bundler/man/bundle-outdated.1.ronn
View File

@ -32,7 +32,7 @@ are up to date, Bundler will exit with a status of 0. Otherwise, it will exit 1.
* `--pre`:
Check for newer pre-release gems.
* `--source`:
* `--source=<list>`:
Check against a specific source.
* `--filter-strict`, `--strict`:
@ -44,7 +44,7 @@ are up to date, Bundler will exit with a status of 0. Otherwise, it will exit 1.
* `--parseable`, `--porcelain`:
Use minimal formatting for more parseable output.
* `--group`:
* `--group=GROUP`:
List gems from a specific group.
* `--groups`:

12
lib/bundler/man/bundle-update.1
View File

@ -4,7 +4,7 @@
.SH "NAME"
\fBbundle\-update\fR \- Update your gems to the latest available versions
.SH "SYNOPSIS"
\fBbundle update\fR \fI*gems\fR [\-\-all] [\-\-group=NAME] [\-\-source=NAME] [\-\-local] [\-\-ruby] [\-\-bundler[=VERSION]] [\-\-full\-index] [\-\-gemfile=GEMFILE] [\-\-jobs=JOBS] [\-\-quiet] [\-\-patch|\-\-minor|\-\-major] [\-\-pre] [\-\-redownload] [\-\-strict] [\-\-conservative]
\fBbundle update\fR \fI*gems\fR [\-\-all] [\-\-group=NAME] [\-\-source=NAME] [\-\-local] [\-\-ruby] [\-\-bundler[=VERSION]] [\-\-full\-index] [\-\-gemfile=GEMFILE] [\-\-jobs=NUMBER] [\-\-quiet] [\-\-patch|\-\-minor|\-\-major] [\-\-pre] [\-\-redownload] [\-\-strict] [\-\-conservative]
.SH "DESCRIPTION"
Update the gems specified (all gems, if \fB\-\-all\fR flag is used), ignoring the previously installed gems specified in the \fBGemfile\.lock\fR\. In general, you should use bundle install(1) \fIbundle\-install\.1\.html\fR to install the same exact gems and versions across machines\.
.P
@ -14,10 +14,10 @@ You would use \fBbundle update\fR to explicitly update the version of a gem\.
\fB\-\-all\fR
Update all gems specified in Gemfile\.
.TP
\fB\-\-group=<name>\fR, \fB\-g=[<name>]\fR
\fB\-\-group=<list>\fR, \fB\-g=<list>\fR
Only update the gems in the specified group\. For instance, you can update all gems in the development group with \fBbundle update \-\-group development\fR\. You can also call \fBbundle update rails \-\-group test\fR to update the rails gem and all gems in the test group, for example\.
.TP
\fB\-\-source=<name>\fR
\fB\-\-source=<list>\fR
The name of a \fB:git\fR or \fB:path\fR source used in the Gemfile(5)\. For instance, with a \fB:git\fR source of \fBhttp://github\.com/rails/rails\.git\fR, you would call \fBbundle update \-\-source rails\fR
.TP
\fB\-\-local\fR
@ -26,7 +26,7 @@ Do not attempt to fetch gems remotely and use the gem cache instead\.
\fB\-\-ruby\fR
Update the locked version of Ruby to the current version of Ruby\.
.TP
\fB\-\-bundler\fR
\fB\-\-bundler[=BUNDLER]\fR
Update the locked version of bundler to the invoked bundler version\.
.TP
\fB\-\-full\-index\fR
@ -35,7 +35,7 @@ Fall back to using the single\-file index of all gems\.
\fB\-\-gemfile=GEMFILE\fR
Use the specified gemfile instead of [\fBGemfile(5)\fR][Gemfile(5)]\.
.TP
\fB\-\-jobs=[<number>]\fR, \fB\-j[<number>]\fR
\fB\-\-jobs=<number>\fR, \fB\-j=<number>\fR
Specify the number of jobs to run in parallel\. The default is the number of available processors\.
.TP
\fB\-\-retry=[<number>]\fR
@ -44,7 +44,7 @@ Retry failed network or git requests for \fInumber\fR times\.
\fB\-\-quiet\fR
Only output warnings and errors\.
.TP
\fB\-\-redownload\fR
\fB\-\-redownload\fR, \fB\-\-force\fR
Force downloading every gem\.
.TP
\fB\-\-patch\fR

12
lib/bundler/man/bundle-update.1.ronn
View File

@ -11,7 +11,7 @@ bundle-update(1) -- Update your gems to the latest available versions
[--bundler[=VERSION]]
[--full-index]
[--gemfile=GEMFILE]
[--jobs=JOBS]
[--jobs=NUMBER]
[--quiet]
[--patch|--minor|--major]
[--pre]
@ -34,13 +34,13 @@ gem.
* `--all`:
Update all gems specified in Gemfile.
* `--group=<name>`, `-g=[<name>]`:
* `--group=<list>`, `-g=<list>`:
Only update the gems in the specified group. For instance, you can update all gems
in the development group with `bundle update --group development`. You can also
call `bundle update rails --group test` to update the rails gem and all gems in
the test group, for example.
* `--source=<name>`:
* `--source=<list>`:
The name of a `:git` or `:path` source used in the Gemfile(5). For
instance, with a `:git` source of `http://github.com/rails/rails.git`,
you would call `bundle update --source rails`
@ -51,7 +51,7 @@ gem.
* `--ruby`:
Update the locked version of Ruby to the current version of Ruby.
* `--bundler`:
* `--bundler[=BUNDLER]`:
Update the locked version of bundler to the invoked bundler version.
* `--full-index`:
@ -60,7 +60,7 @@ gem.
* `--gemfile=GEMFILE`:
Use the specified gemfile instead of [`Gemfile(5)`][Gemfile(5)].
* `--jobs=[<number>]`, `-j[<number>]`:
* `--jobs=<number>`, `-j=<number>`:
Specify the number of jobs to run in parallel. The default is the number of
available processors.
@ -70,7 +70,7 @@ gem.
* `--quiet`:
Only output warnings and errors.
* `--redownload`:
* `--redownload`, `--force`:
Force downloading every gem.
* `--patch`:

6
lib/bundler/man/bundle-viz.1
View File

@ -13,10 +13,10 @@ The associated gems must also be installed via \fBbundle install(1)\fR \fIbundle
\fBviz\fR command was deprecated in Bundler 2\.2\. Use bundler\-graph plugin \fIhttps://github\.com/rubygems/bundler\-graph\fR instead\.
.SH "OPTIONS"
.TP
\fB\-\-file\fR, \fB\-f\fR
\fB\-\-file=FILE\fR, \fB\-f=FILE\fR
The name to use for the generated file\. See \fB\-\-format\fR option
.TP
\fB\-\-format\fR, \fB\-F\fR
\fB\-\-format=FORMAT\fR, \fB\-F=FORMAT\fR
This is output format option\. Supported format is png, jpg, svg, dot \|\.\|\.\|\.
.TP
\fB\-\-requirements\fR, \fB\-R\fR
@ -25,6 +25,6 @@ Set to show the version of each required dependency\.
\fB\-\-version\fR, \fB\-v\fR
Set to show each gem version\.
.TP
\fB\-\-without\fR, \fB\-W\fR
\fB\-\-without=<list>\fR, \fB\-W=<list>\fR
Exclude gems that are part of the specified named group\.

6
lib/bundler/man/bundle-viz.1.ronn
View File

@ -20,10 +20,10 @@ The associated gems must also be installed via [`bundle install(1)`](bundle-inst
## OPTIONS
* `--file`, `-f`:
* `--file=FILE`, `-f=FILE`:
The name to use for the generated file. See `--format` option
* `--format`, `-F`:
* `--format=FORMAT`, `-F=FORMAT`:
This is output format option. Supported format is png, jpg, svg, dot ...
* `--requirements`, `-R`:
@ -32,5 +32,5 @@ The associated gems must also be installed via [`bundle install(1)`](bundle-inst
* `--version`, `-v`:
Set to show each gem version.
* `--without`, `-W`:
* `--without=<list>`, `-W=<list>`:
Exclude gems that are part of the specified named group.

46
spec/bundler/other/cli_man_pages_spec.rb
View File

@ -9,8 +9,54 @@ RSpec.describe "bundle commands" do
end
end
it "expects all commands to have all options documented" do
Bundler::CLI.all_commands.each do |command_name, command|
next if command_name == "cli_help"
man_page_content = man_page(command_name).read
command.options.each do |_, option|
aliases = option.aliases
formatted_aliases = aliases.sort.map {|name| "`#{name}`" }.join(", ") if aliases
help = if option.type == :boolean
"* #{append_aliases("`#{option.switch_name}`", formatted_aliases)}:"
elsif option.enum
formatted_aliases = "`#{option.switch_name}`" if aliases.empty? && option.lazy_default
"* #{prepend_aliases(option.enum.sort.map {|enum| "`#{option.switch_name}=#{enum}`" }.join(", "), formatted_aliases)}:"
else
names = [option.switch_name, *aliases]
value =
case option.type
when :array then "<list>"
when :numeric then "<number>"
else option.name.upcase
end
value = option.type != :numeric && option.lazy_default ? "[=#{value}]" : "=#{value}"
"* #{names.map {|name| "`#{name}#{value}`" }.join(", ")}:"
end
expect(man_page_content).to include(help)
end
end
end
private
def append_aliases(text, aliases)
return text if aliases.empty?
"#{text}, #{aliases}"
end
def prepend_aliases(text, aliases)
return text if aliases.empty?
"#{aliases}, #{text}"
end
def man_page(command_name)
source_root.join("lib/bundler/man/bundle-#{command_name}.1.ronn")
end

1
spec/bundler/spec_helper.rb
View File

@ -82,6 +82,7 @@ RSpec.configure do |config|
ENV["RUBYGEMS_GEMDEPS"] = nil
ENV["XDG_CONFIG_HOME"] = nil
ENV["GEMRC"] = nil
ENV["EDITOR"] = nil
# Don't wrap output in tests
ENV["THOR_COLUMNS"] = "10000"