Skip to content

Commit 20a8348

Browse files
Normalize CLI flag documentation and make sure all flags are documented
1 parent 92f7767 commit 20a8348

28 files changed

+149
-101
lines changed

bundler/lib/bundler/man/bundle-add.1

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,31 @@
99
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\.
1010
.SH "OPTIONS"
1111
.TP
12-
\fB\-\-version\fR, \fB\-v\fR
12+
\fB\-\-version=VERSION\fR, \fB\-v=VERSION\fR
1313
Specify version requirements(s) for the added gem\.
1414
.TP
15-
\fB\-\-group\fR, \fB\-g\fR
15+
\fB\-\-group=GROUP\fR, \fB\-g=GROUP\fR
1616
Specify the group(s) for the added gem\. Multiple groups should be separated by commas\.
1717
.TP
18-
\fB\-\-source\fR, \fB\-s\fR
18+
\fB\-\-source=SOURCE\fR, \fB\-s=SOURCE\fR
1919
Specify the source for the added gem\.
2020
.TP
21-
\fB\-\-require\fR, \fB\-r\fR
21+
\fB\-\-require=REQUIRE\fR, \fB\-r=REQUIRE\fR
2222
Adds require path to gem\. Provide false, or a path as a string\.
2323
.TP
24-
\fB\-\-path\fR
24+
\fB\-\-path=PATH\fR
2525
Specify the file system path for the added gem\.
2626
.TP
27-
\fB\-\-git\fR
27+
\fB\-\-git=GIT\fR
2828
Specify the git source for the added gem\.
2929
.TP
30-
\fB\-\-github\fR
30+
\fB\-\-github=GITHUB\fR
3131
Specify the github source for the added gem\.
3232
.TP
33-
\fB\-\-branch\fR
33+
\fB\-\-branch=BRANCH\fR
3434
Specify the git branch for the added gem\.
3535
.TP
36-
\fB\-\-ref\fR
36+
\fB\-\-ref=REF\fR
3737
Specify the git ref for the added gem\.
3838
.TP
3939
\fB\-\-glob=GLOB\fR

bundler/lib/bundler/man/bundle-add.1.ronn

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,31 @@ Adds the named gem to the [`Gemfile(5)`][Gemfile(5)] and run `bundle install`.
1414

1515
## OPTIONS
1616

17-
* `--version`, `-v`:
17+
* `--version=VERSION`, `-v=VERSION`:
1818
Specify version requirements(s) for the added gem.
1919

20-
* `--group`, `-g`:
20+
* `--group=GROUP`, `-g=GROUP`:
2121
Specify the group(s) for the added gem. Multiple groups should be separated by commas.
2222

23-
* `--source`, `-s`:
23+
* `--source=SOURCE`, `-s=SOURCE`:
2424
Specify the source for the added gem.
2525

26-
* `--require`, `-r`:
26+
* `--require=REQUIRE`, `-r=REQUIRE`:
2727
Adds require path to gem. Provide false, or a path as a string.
2828

29-
* `--path`:
29+
* `--path=PATH`:
3030
Specify the file system path for the added gem.
3131

32-
* `--git`:
32+
* `--git=GIT`:
3333
Specify the git source for the added gem.
3434

35-
* `--github`:
35+
* `--github=GITHUB`:
3636
Specify the github source for the added gem.
3737

38-
* `--branch`:
38+
* `--branch=BRANCH`:
3939
Specify the git branch for the added gem.
4040

41-
* `--ref`:
41+
* `--ref=REF`:
4242
Specify the git ref for the added gem.
4343

4444
* `--glob=GLOB`:

bundler/lib/bundler/man/bundle-binstubs.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ This command generates binstubs for executables in \fBGEM_NAME\fR\. Binstubs are
1616
\fB\-\-force\fR
1717
Overwrite existing binstubs if they exist\.
1818
.TP
19-
\fB\-\-path\fR
19+
\fB\-\-path[=PATH]\fR
2020
The location to install the specified binstubs to\. This defaults to \fBbin\fR\.
2121
.TP
2222
\fB\-\-standalone\fR
2323
Makes binstubs that can work without depending on Rubygems or Bundler at runtime\.
2424
.TP
25-
\fB\-\-shebang\fR
25+
\fB\-\-shebang=SHEBANG\fR
2626
Specify a different shebang executable name than the default (default 'ruby')
2727
.TP
2828
\fB\-\-all\fR

bundler/lib/bundler/man/bundle-binstubs.1.ronn

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ Calling binstubs with [GEM [GEM]] will create binstubs for all given gems.
2727
* `--force`:
2828
Overwrite existing binstubs if they exist.
2929

30-
* `--path`:
30+
* `--path[=PATH]`:
3131
The location to install the specified binstubs to. This defaults to `bin`.
3232

3333
* `--standalone`:
3434
Makes binstubs that can work without depending on Rubygems or Bundler at
3535
runtime.
3636

37-
* `--shebang`:
37+
* `--shebang=SHEBANG`:
3838
Specify a different shebang executable name than the default (default 'ruby')
3939

4040
* `--all`:

bundler/lib/bundler/man/bundle-check.1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ If the lockfile needs to be updated then it will be resolved using the gems inst
1616
\fB\-\-dry\-run\fR
1717
Locks the [\fBGemfile(5)\fR][Gemfile(5)] before running the command\.
1818
.TP
19-
\fB\-\-gemfile\fR
19+
\fB\-\-gemfile=GEMFILE\fR
2020
Use the specified gemfile instead of the [\fBGemfile(5)\fR][Gemfile(5)]\.
2121
.TP
22-
\fB\-\-path\fR
22+
\fB\-\-path=PATH\fR
2323
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\.
2424

bundler/lib/bundler/man/bundle-check.1.ronn

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ installed on the local machine, if they satisfy the requirements.
2323
* `--dry-run`:
2424
Locks the [`Gemfile(5)`][Gemfile(5)] before running the command.
2525

26-
* `--gemfile`:
26+
* `--gemfile=GEMFILE`:
2727
Use the specified gemfile instead of the [`Gemfile(5)`][Gemfile(5)].
2828

29-
* `--path`:
29+
* `--path=PATH`:
3030
Specify a different path than the system default (`$BUNDLE_PATH` or `$GEM_HOME`).
3131
Bundler will remember this value for future installs on this machine.

bundler/lib/bundler/man/bundle-doctor.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ Missing dependencies
2525
\fB\-\-quiet\fR
2626
Only output warnings and errors\.
2727
.TP
28-
\fB\-\-gemfile=<gemfile>\fR
28+
\fB\-\-gemfile=GEMFILE\fR
2929
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\.
3030

bundler/lib/bundler/man/bundle-doctor.1.ronn

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Examples of common problems caught by bundle-doctor include:
2525
* `--quiet`:
2626
Only output warnings and errors.
2727

28-
* `--gemfile=<gemfile>`:
28+
* `--gemfile=GEMFILE`:
2929
The location of the Gemfile(5) which Bundler should use. This defaults
3030
to a Gemfile(5) in the current working directory. In general, Bundler
3131
will assume that the location of the Gemfile(5) is also the project's

bundler/lib/bundler/man/bundle-fund.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
\fBbundle fund\fR lists information about gems seeking funding assistance\.
1010
.SH "OPTIONS"
1111
.TP
12-
\fB\-g\fR, \fB\-\-group=GROUP\fR
12+
\fB\-\-group=<list>\fR, \fB\-g=<list>\fR
1313
Fetch funding information for a specific group\.
1414
.SH "EXAMPLES"
1515
.nf

bundler/lib/bundler/man/bundle-fund.1.ronn

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ bundle-fund(1) -- Lists information about gems seeking funding assistance
1111

1212
## OPTIONS
1313

14-
* `-g`, `--group=GROUP`:
14+
* `--group=<list>`, `-g=<list>`:
1515
Fetch funding information for a specific group.
1616

1717
## EXAMPLES

0 commit comments

Comments
 (0)