Skip to content

Commit 0620ae0

Browse files
jnavilagitster
authored andcommitted
doc: format alternatives in synopsis
This is a list of various fixes on malformed alternative in commands and option syntax. Signed-off-by: Jean-Noël Avila <[email protected]> Acked-by: Taylor Blau <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 3c2a3fd commit 0620ae0

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

Documentation/fetch-options.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ endif::git-pull[]
202202
destination of an explicit refspec; see `--prune`).
203203

204204
ifndef::git-pull[]
205-
--recurse-submodules[=yes|on-demand|no]::
205+
--recurse-submodules[=(yes|on-demand|no)]::
206206
This option controls if and under what conditions new commits of
207207
submodules should be fetched too. When recursing through submodules,
208208
`git fetch` always attempts to fetch "changed" submodules, that is, a

Documentation/git-pull.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ OPTIONS
8787
--verbose::
8888
Pass --verbose to git-fetch and git-merge.
8989

90-
--[no-]recurse-submodules[=yes|on-demand|no]::
90+
--[no-]recurse-submodules[=(yes|on-demand|no)]::
9191
This option controls if new commits of populated submodules should
9292
be fetched, and if the working trees of active submodules should be
9393
updated, too (see linkgit:git-fetch[1], linkgit:git-config[1] and
@@ -105,7 +105,7 @@ Options related to merging
105105
include::merge-options.txt[]
106106

107107
-r::
108-
--rebase[=false|true|merges|interactive]::
108+
--rebase[=(false|true|merges|interactive)]::
109109
When true, rebase the current branch on top of the upstream
110110
branch after fetching. If there is a remote-tracking branch
111111
corresponding to the upstream branch and the upstream branch

Documentation/git-rebase.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ SYNOPSIS
1212
[--onto <newbase> | --keep-base] [<upstream> [<branch>]]
1313
'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
1414
--root [<branch>]
15-
'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)
15+
'git rebase' (--continue|--skip|--abort|--quit|--edit-todo|--show-current-patch)
1616

1717
DESCRIPTION
1818
-----------

Documentation/git-send-email.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-send-email - Send a collection of patches as emails
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git send-email' [<options>] <file|directory>...
12+
'git send-email' [<options>] (<file>|<directory>)...
1313
'git send-email' [<options>] <format-patch-options>
1414
'git send-email' --dump-aliases
1515

@@ -278,7 +278,7 @@ must be used for each option.
278278
if a username is not specified (with `--smtp-user` or `sendemail.smtpUser`),
279279
then authentication is not attempted.
280280

281-
--smtp-debug=0|1::
281+
--smtp-debug=(0|1)::
282282
Enable (1) or disable (0) debug output. If enabled, SMTP
283283
commands and replies will be printed. Useful to debug TLS
284284
connection and authentication problems.
@@ -301,7 +301,9 @@ must be used for each option.
301301
Automating
302302
~~~~~~~~~~
303303

304-
--no-[to|cc|bcc]::
304+
--no-to::
305+
--no-cc::
306+
--no-bcc::
305307
Clears any list of "To:", "Cc:", "Bcc:" addresses previously
306308
set via config.
307309

0 commit comments

Comments
 (0)