From de613050efec781e8380a0267879a25b2d489513 Mon Sep 17 00:00:00 2001 From: "Robert P. J. Day" Date: Thu, 24 May 2018 16:11:39 -0400 Subject: [PATCH] Use proper syntax for replaceables in command docs The standard for command documentation synopses appears to be: [...] means optional <...> means replaceable [<...>] means both optional and replaceable So fix a number of doc pages that use incorrect variations of the above. Signed-off-by: Robert P. J. Day Signed-off-by: Junio C Hamano --- Documentation/git-annotate.txt | 2 +- Documentation/git-check-attr.txt | 4 ++-- Documentation/git-check-ignore.txt | 4 ++-- Documentation/git-check-mailmap.txt | 2 +- Documentation/git-credential-cache.txt | 2 +- Documentation/git-credential-store.txt | 2 +- Documentation/git-cvsserver.txt | 2 +- Documentation/git-diff.txt | 26 ++++++++++++------------ Documentation/git-fast-export.txt | 2 +- Documentation/git-fast-import.txt | 2 +- Documentation/git-interpret-trailers.txt | 4 ++-- Documentation/git-pull.txt | 2 +- Documentation/git-rebase.txt | 4 ++-- Documentation/git-rev-parse.txt | 6 +++--- Documentation/git-send-email.txt | 2 +- Documentation/git-show.txt | 2 +- Documentation/git-svn.txt | 2 +- Documentation/git-web--browse.txt | 2 +- Documentation/gitcli.txt | 4 ++-- 19 files changed, 38 insertions(+), 38 deletions(-) diff --git a/Documentation/git-annotate.txt b/Documentation/git-annotate.txt index 05fd482b74..e44a831339 100644 --- a/Documentation/git-annotate.txt +++ b/Documentation/git-annotate.txt @@ -8,7 +8,7 @@ git-annotate - Annotate file lines with commit information SYNOPSIS -------- [verse] -'git annotate' [options] file [revision] +'git annotate' [] [] DESCRIPTION ----------- diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt index aa3b2bf2fc..3c0578217b 100644 --- a/Documentation/git-check-attr.txt +++ b/Documentation/git-check-attr.txt @@ -9,8 +9,8 @@ git-check-attr - Display gitattributes information SYNOPSIS -------- [verse] -'git check-attr' [-a | --all | attr...] [--] pathname... -'git check-attr' --stdin [-z] [-a | --all | attr...] +'git check-attr' [-a | --all | ...] [--] ... +'git check-attr' --stdin [-z] [-a | --all | ...] DESCRIPTION ----------- diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt index 611754f10b..8b42cb3fb2 100644 --- a/Documentation/git-check-ignore.txt +++ b/Documentation/git-check-ignore.txt @@ -9,8 +9,8 @@ git-check-ignore - Debug gitignore / exclude files SYNOPSIS -------- [verse] -'git check-ignore' [options] pathname... -'git check-ignore' [options] --stdin +'git check-ignore' [] ... +'git check-ignore' [] --stdin DESCRIPTION ----------- diff --git a/Documentation/git-check-mailmap.txt b/Documentation/git-check-mailmap.txt index 39028ee1a3..aa2055dbeb 100644 --- a/Documentation/git-check-mailmap.txt +++ b/Documentation/git-check-mailmap.txt @@ -9,7 +9,7 @@ git-check-mailmap - Show canonical names and email addresses of contacts SYNOPSIS -------- [verse] -'git check-mailmap' [options] ... +'git check-mailmap' [] ... DESCRIPTION diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt index 2b85826393..0216c18ef8 100644 --- a/Documentation/git-credential-cache.txt +++ b/Documentation/git-credential-cache.txt @@ -8,7 +8,7 @@ git-credential-cache - Helper to temporarily store passwords in memory SYNOPSIS -------- ----------------------------- -git config credential.helper 'cache [options]' +git config credential.helper 'cache []' ----------------------------- DESCRIPTION diff --git a/Documentation/git-credential-store.txt b/Documentation/git-credential-store.txt index 25fb963f4b..693dd9d9d7 100644 --- a/Documentation/git-credential-store.txt +++ b/Documentation/git-credential-store.txt @@ -8,7 +8,7 @@ git-credential-store - Helper to store credentials on disk SYNOPSIS -------- ------------------- -git config credential.helper 'store [options]' +git config credential.helper 'store []' ------------------- DESCRIPTION diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt index 37b96c5453..f98b7c6ed7 100644 --- a/Documentation/git-cvsserver.txt +++ b/Documentation/git-cvsserver.txt @@ -22,7 +22,7 @@ cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver Usage: [verse] -'git-cvsserver' [options] [pserver|server] [ ...] +'git-cvsserver' [] [pserver|server] [ ...] OPTIONS ------- diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 7c2c442700..b180f1fa5b 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -9,11 +9,11 @@ git-diff - Show changes between commits, commit and working tree, etc SYNOPSIS -------- [verse] -'git diff' [options] [] [--] [...] -'git diff' [options] --cached [] [--] [...] -'git diff' [options] [--] [...] -'git diff' [options] -'git diff' [options] --no-index [--] +'git diff' [] [] [--] [...] +'git diff' [] --cached [] [--] [...] +'git diff' [] [--] [...] +'git diff' [] +'git diff' [] --no-index [--] DESCRIPTION ----------- @@ -21,7 +21,7 @@ Show changes between the working tree and the index or a tree, changes between the index and a tree, changes between two trees, changes between two blob objects, or changes between two files on disk. -'git diff' [options] [--] [...]:: +'git diff' [] [--] [...]:: This form is to view the changes you made relative to the index (staging area for the next commit). In other @@ -29,7 +29,7 @@ two blob objects, or changes between two files on disk. further add to the index but you still haven't. You can stage these changes by using linkgit:git-add[1]. -'git diff' [options] --no-index [--] :: +'git diff' [] --no-index [--] :: This form is to compare the given two paths on the filesystem. You can omit the `--no-index` option when @@ -38,7 +38,7 @@ two blob objects, or changes between two files on disk. or when running the command outside a working tree controlled by Git. -'git diff' [options] --cached [] [--] [...]:: +'git diff' [] --cached [] [--] [...]:: This form is to view the changes you staged for the next commit relative to the named . Typically you @@ -48,7 +48,7 @@ two blob objects, or changes between two files on disk. is not given, it shows all staged changes. --staged is a synonym of --cached. -'git diff' [options] [--] [...]:: +'git diff' [] [--] [...]:: This form is to view the changes you have in your working tree relative to the named . You can @@ -56,18 +56,18 @@ two blob objects, or changes between two files on disk. branch name to compare with the tip of a different branch. -'git diff' [options] [--] [...]:: +'git diff' [] [--] [...]:: This is to view the changes between two arbitrary . -'git diff' [options] .. [--] [...]:: +'git diff' [] .. [--] [...]:: This is synonymous to the previous form. If on one side is omitted, it will have the same effect as using HEAD instead. -'git diff' [options] \... [--] [...]:: +'git diff' [] \... [--] [...]:: This form is to view the changes on the branch containing and up to the second , starting at a common ancestor @@ -87,7 +87,7 @@ and the range notations (".." and "\...") do not mean a range as defined in the "SPECIFYING RANGES" section in linkgit:gitrevisions[7]. -'git diff' [options] :: +'git diff' [] :: This form is to view the differences between the raw contents of two blob objects. diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt index 44098595dd..ce954be532 100644 --- a/Documentation/git-fast-export.txt +++ b/Documentation/git-fast-export.txt @@ -9,7 +9,7 @@ git-fast-export - Git data exporter SYNOPSIS -------- [verse] -'git fast-export [options]' | 'git fast-import' +'git fast-export []' | 'git fast-import' DESCRIPTION ----------- diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index cdf696ff7f..e81117d27f 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -9,7 +9,7 @@ git-fast-import - Backend for fast Git data importers SYNOPSIS -------- [verse] -frontend | 'git fast-import' [options] +frontend | 'git fast-import' [] DESCRIPTION ----------- diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index ff446f15f7..9111c47a1b 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -8,8 +8,8 @@ git-interpret-trailers - add or parse structured information in commit messages SYNOPSIS -------- [verse] -'git interpret-trailers' [options] [(--trailer [(=|:)])...] [...] -'git interpret-trailers' [options] [--parse] [...] +'git interpret-trailers' [] [(--trailer [(=|:)])...] [...] +'git interpret-trailers' [] [--parse] [...] DESCRIPTION ----------- diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt index 4e0ad6fd8e..118d9d86f7 100644 --- a/Documentation/git-pull.txt +++ b/Documentation/git-pull.txt @@ -9,7 +9,7 @@ git-pull - Fetch from and integrate with another repository or a local branch SYNOPSIS -------- [verse] -'git pull' [options] [ [...]] +'git pull' [] [ [...]] DESCRIPTION diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index bd5ecff980..0e20a66e73 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -8,9 +8,9 @@ git-rebase - Reapply commits on top of another base tip SYNOPSIS -------- [verse] -'git rebase' [-i | --interactive] [options] [--exec ] [--onto ] +'git rebase' [-i | --interactive] [] [--exec ] [--onto ] [ []] -'git rebase' [-i | --interactive] [options] [--exec ] [--onto ] +'git rebase' [-i | --interactive] [] [--exec ] [--onto ] --root [] 'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index 95326b85ff..e72d332b83 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -9,7 +9,7 @@ git-rev-parse - Pick out and massage parameters SYNOPSIS -------- [verse] -'git rev-parse' [ --option ] ... +'git rev-parse' [] ... DESCRIPTION ----------- @@ -360,7 +360,7 @@ Example ------------ OPTS_SPEC="\ -some-command [options] ... +some-command [] ... some-command does foo and bar! -- @@ -385,7 +385,7 @@ When `"$@"` is `-h` or `--help` in the above example, the following usage text would be shown: ------------ -usage: some-command [options] ... +usage: some-command [] ... some-command does foo and bar! diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index 464c15b94f..4f3efde80c 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -9,7 +9,7 @@ git-send-email - Send a collection of patches as emails SYNOPSIS -------- [verse] -'git send-email' [options] ... +'git send-email' [] ... 'git send-email' --dump-aliases diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt index 0e1695df35..fcf528c1b3 100644 --- a/Documentation/git-show.txt +++ b/Documentation/git-show.txt @@ -9,7 +9,7 @@ git-show - Show various types of objects SYNOPSIS -------- [verse] -'git show' [options] [...] +'git show' [] [...] DESCRIPTION ----------- diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt index e9615951d2..7ea24fc942 100644 --- a/Documentation/git-svn.txt +++ b/Documentation/git-svn.txt @@ -8,7 +8,7 @@ git-svn - Bidirectional operation between a Subversion repository and Git SYNOPSIS -------- [verse] -'git svn' [options] [arguments] +'git svn' [] [] DESCRIPTION ----------- diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt index a4ec25b450..fd952a5ff9 100644 --- a/Documentation/git-web--browse.txt +++ b/Documentation/git-web--browse.txt @@ -8,7 +8,7 @@ git-web--browse - Git helper script to launch a web browser SYNOPSIS -------- [verse] -'git web{litdd}browse' [OPTIONS] URL/FILE ... +'git web{litdd}browse' [] ... DESCRIPTION ----------- diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index 9f13266a68..592e06d839 100644 --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt @@ -110,8 +110,8 @@ couple of magic command-line options: + --------------------------------------------- $ git describe -h -usage: git describe [options] * - or: git describe [options] --dirty +usage: git describe [] * + or: git describe [] --dirty --contains find the tag that comes after the commit --debug debug search strategy on stderr -- 2.39.2