Skip to content

Commit f3d62db

Browse files
deivid-rodriguezhsbt
authored andcommitted
[rubygems/rubygems] Improve doctor CLI flag documentation
Name default value placeholders in a more standard way. That's what our specs check, but they don't yet work for subcommand flags. ruby/rubygems@c589899cb8
1 parent 12c200a commit f3d62db

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

lib/bundler/man/bundle-doctor.1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
.SH "SYNOPSIS"
77
\fBbundle doctor [diagnose]\fR [\-\-quiet] [\-\-gemfile=GEMFILE] [\-\-ssl]
88
.br
9-
\fBbundle doctor ssl\fR [\-\-host=HOST] [\-\-tls\-version=VERSION] [\-\-verify\-mode=MODE]
9+
\fBbundle doctor ssl\fR [\-\-host=HOST] [\-\-tls\-version=TLS\-VERSION] [\-\-verify\-mode=VERIFY\-MODE]
1010
.br
1111
\fBbundle doctor\fR help [COMMAND]
1212
.SH "DESCRIPTION"
@@ -57,12 +57,12 @@ Open a TLS connection and verify the outcome\.
5757
\fB\-\-host=HOST\fR
5858
Perform the diagnostic on HOST\. Defaults to \fBrubygems\.org\fR\.
5959
.TP
60-
\fB\-\-tls\-version=VERSION\fR
60+
\fB\-\-tls\-version=TLS\-VERSION\fR
6161
Specify the TLS version when opening the connection to HOST\.
6262
.IP
6363
Accepted values are: \fB1\.1\fR or \fB1\.2\fR\.
6464
.TP
65-
\fB\-\-verify\-mode=MODE\fR
65+
\fB\-\-verify\-mode=VERIFY\-MODE\fR
6666
Specify the TLS verify mode when opening the connection to HOST\. Defaults to \fBSSL_VERIFY_PEER\fR\.
6767
.IP
6868
Accepted values are: \fBCLIENT_ONCE\fR, \fBFAIL_IF_NO_PEER_CERT\fR, \fBNONE\fR, \fBPEER\fR\.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ bundle-doctor(1) -- Checks the bundle for common problems
77
[--gemfile=GEMFILE]
88
[--ssl]<br>
99
`bundle doctor ssl` [--host=HOST]
10-
[--tls-version=VERSION]
11-
[--verify-mode=MODE]<br>
10+
[--tls-version=TLS-VERSION]
11+
[--verify-mode=VERIFY-MODE]<br>
1212
`bundle doctor` help [COMMAND]
1313

1414
## DESCRIPTION
@@ -65,12 +65,12 @@ The diagnostic will perform a few checks such as:
6565
* `--host=HOST`:
6666
Perform the diagnostic on HOST. Defaults to `rubygems.org`.
6767

68-
* `--tls-version=VERSION`:
68+
* `--tls-version=TLS-VERSION`:
6969
Specify the TLS version when opening the connection to HOST.
7070

7171
Accepted values are: `1.1` or `1.2`.
7272

73-
* `--verify-mode=MODE`:
73+
* `--verify-mode=VERIFY-MODE`:
7474
Specify the TLS verify mode when opening the connection to HOST.
7575
Defaults to `SSL_VERIFY_PEER`.
7676

0 commit comments

Comments
 (0)