show --continue/skip etc. consistently in synopsis
authorPhillip Wood <phillip.wood@dunelm.org.uk>
Mon, 17 Jun 2019 09:17:09 +0000 (10:17 +0100)
committerJunio C Hamano <gitster@pobox.com>
Tue, 18 Jun 2019 01:18:23 +0000 (18:18 -0700)
Command mode options that the user can choose one among many are
listed like this in the documentation:

git am (--continue | --skip | --abort | --quit)

They are listed on a single line and in parenthesis, because they
are not optional.

But documentation pages for some commands deviate from this norm.
Fix the merge and rebase docs to match this style.

Signed-off-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-merge.txt
Documentation/git-rebase.txt
index b7d581fc76f8d768838ed5790af19827efe088be..926ea4f460994b44fa5667e478eed8d1d8f5ab5b 100644 (file)
@@ -13,8 +13,7 @@ SYNOPSIS
        [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
        [--[no-]allow-unrelated-histories]
        [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]
-'git merge' --abort
-'git merge' --continue
+'git merge' (--continue | --abort | --quit)
 
 DESCRIPTION
 -----------
index 5629ba4c5d2b06385911d2c8ba25a496ce78c263..a67d40596a1e14f562440bf47a97f8622bc98544 100644 (file)
@@ -12,7 +12,7 @@ SYNOPSIS
        [<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
 -----------