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 <jn.avila@free.fr> Acked-by: Taylor Blau <me@ttaylorr.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
Mar 16, 2024 at 15:21 UTC
0620ae0f5bf0f029def9e4ad27308698dfd0fdaf
4 files changed
+9
-7
Documentation/fetch-options.txt
+1
-1
@@ -202,7 +202,7 @@ endif::git-pull[]
202
destination of an explicit refspec; see `--prune`).
203
204
ifndef::git-pull[]
205
---recurse-submodules[=yes|on-demand|no]::
205
+--recurse-submodules[=(yes|on-demand|no)]::
206
This option controls if and under what conditions new commits of
207
submodules should be fetched too. When recursing through submodules,
208
`git fetch` always attempts to fetch "changed" submodules, that is, a
Documentation/git-pull.txt
+2
-2
@@ -87,7 +87,7 @@ OPTIONS
87
--verbose::
88
Pass --verbose to git-fetch and git-merge.
89
90
---[no-]recurse-submodules[=yes|on-demand|no]::
90
+--[no-]recurse-submodules[=(yes|on-demand|no)]::
91
This option controls if new commits of populated submodules should
92
be fetched, and if the working trees of active submodules should be
93
updated, too (see linkgit:git-fetch[1], linkgit:git-config[1] and
@@ -105,7 +105,7 @@ Options related to merging
105
include::merge-options.txt[]
106
107
-r::
108
---rebase[=false|true|merges|interactive]::
108
+--rebase[=(false|true|merges|interactive)]::
109
When true, rebase the current branch on top of the upstream
110
branch after fetching. If there is a remote-tracking branch
111
corresponding to the upstream branch and the upstream branch
Documentation/git-rebase.txt
+1
-1
@@ -12,7 +12,7 @@ SYNOPSIS
12
[--onto <newbase> | --keep-base] [<upstream> [<branch>]]
13
'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
14
--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)
16
17
DESCRIPTION
18
-----------
Documentation/git-send-email.txt
+5
-3
@@ -9,7 +9,7 @@ git-send-email - Send a collection of patches as emails
9
SYNOPSIS
10
--------
11
[verse]
12
-'git send-email' [<options>] <file|directory>...
12
+'git send-email' [<options>] (<file>|<directory>)...
13
'git send-email' [<options>] <format-patch-options>
14
'git send-email' --dump-aliases
15
@@ -278,7 +278,7 @@ must be used for each option.
278
if a username is not specified (with `--smtp-user` or `sendemail.smtpUser`),
279
then authentication is not attempted.
280
281
---smtp-debug=0|1::
281
+--smtp-debug=(0|1)::
282
Enable (1) or disable (0) debug output. If enabled, SMTP
283
commands and replies will be printed. Useful to debug TLS
284
connection and authentication problems.
@@ -301,7 +301,9 @@ must be used for each option.
301
Automating
302
~~~~~~~~~~
303
304
---no-[to|cc|bcc]::
304
+--no-to::
305
+--no-cc::
306
+--no-bcc::
307
Clears any list of "To:", "Cc:", "Bcc:" addresses previously
308
set via config.
309