]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: format alternatives in synopsis
authorJean-Noël Avila <jn.avila@free.fr>
Sat, 16 Mar 2024 15:21:40 +0000 (15:21 +0000)
committerJunio C Hamano <gitster@pobox.com>
Sat, 16 Mar 2024 17:04:45 +0000 (10:04 -0700)
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>
Documentation/fetch-options.txt
Documentation/git-pull.txt
Documentation/git-rebase.txt
Documentation/git-send-email.txt

index 54ebb4452e997f8c62c9dd2421948086249102bd..e22b217fba9e2c6c30ad1f7becea238d0f2a9916 100644 (file)
@@ -202,7 +202,7 @@ endif::git-pull[]
        destination of an explicit refspec; see `--prune`).
 
 ifndef::git-pull[]
---recurse-submodules[=yes|on-demand|no]::
+--recurse-submodules[=(yes|on-demand|no)]::
        This option controls if and under what conditions new commits of
        submodules should be fetched too. When recursing through submodules,
        `git fetch` always attempts to fetch "changed" submodules, that is, a
index 0e14f8b5b25924c98c4bda92729787f2361ada9c..b2ae496e488c1ebf3aaf79609987ab0bdbc5f34a 100644 (file)
@@ -87,7 +87,7 @@ OPTIONS
 --verbose::
        Pass --verbose to git-fetch and git-merge.
 
---[no-]recurse-submodules[=yes|on-demand|no]::
+--[no-]recurse-submodules[=(yes|on-demand|no)]::
        This option controls if new commits of populated submodules should
        be fetched, and if the working trees of active submodules should be
        updated, too (see linkgit:git-fetch[1], linkgit:git-config[1] and
@@ -105,7 +105,7 @@ Options related to merging
 include::merge-options.txt[]
 
 -r::
---rebase[=false|true|merges|interactive]::
+--rebase[=(false|true|merges|interactive)]::
        When true, rebase the current branch on top of the upstream
        branch after fetching. If there is a remote-tracking branch
        corresponding to the upstream branch and the upstream branch
index 06206521fc322b04d6c874193d215e60d2368836..bfd039db47b6f62cf09f8f88188f77c61fb8417e 100644 (file)
@@ -12,7 +12,7 @@ SYNOPSIS
        [--onto <newbase> | --keep-base] [<upstream> [<branch>]]
 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
        --root [<branch>]
-'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)
+'git rebase' (--continue|--skip|--abort|--quit|--edit-todo|--show-current-patch)
 
 DESCRIPTION
 -----------
index d1ef6a204e6833e2e8a1c9d0e909568a7a017300..60c0f713c4bff5588d771862c7bc9adf22c6f072 100644 (file)
@@ -9,7 +9,7 @@ git-send-email - Send a collection of patches as emails
 SYNOPSIS
 --------
 [verse]
-'git send-email' [<options>] <file|directory>...
+'git send-email' [<options>] (<file>|<directory>)...
 'git send-email' [<options>] <format-patch-options>
 'git send-email' --dump-aliases
 
@@ -278,7 +278,7 @@ must be used for each option.
        if a username is not specified (with `--smtp-user` or `sendemail.smtpUser`),
        then authentication is not attempted.
 
---smtp-debug=0|1::
+--smtp-debug=(0|1)::
        Enable (1) or disable (0) debug output. If enabled, SMTP
        commands and replies will be printed. Useful to debug TLS
        connection and authentication problems.
@@ -301,7 +301,9 @@ must be used for each option.
 Automating
 ~~~~~~~~~~
 
---no-[to|cc|bcc]::
+--no-to::
+--no-cc::
+--no-bcc::
        Clears any list of "To:", "Cc:", "Bcc:" addresses previously
        set via config.