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 <rpjday@crashcourse.ca> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Robert P. J. Day committed
May 24, 2018 at 16:11 UTC
de613050efec781e8380a0267879a25b2d489513
19 files changed
+38
-38
Documentation/git-annotate.txt
+1
-1
@@ -8,7 +8,7 @@ git-annotate - Annotate file lines with commit information
8
SYNOPSIS
9
--------
10
[verse]
11
-'git annotate' [options] file [revision]
11
+'git annotate' [<options>] <file> [<revision>]
12
13
DESCRIPTION
14
-----------
Documentation/git-check-attr.txt
+2
-2
@@ -9,8 +9,8 @@ git-check-attr - Display gitattributes information
9
SYNOPSIS
10
--------
11
[verse]
12
-'git check-attr' [-a | --all | attr...] [--] pathname...
13
-'git check-attr' --stdin [-z] [-a | --all | attr...]
12
+'git check-attr' [-a | --all | <attr>...] [--] <pathname>...
13
+'git check-attr' --stdin [-z] [-a | --all | <attr>...]
14
15
DESCRIPTION
16
-----------
Documentation/git-check-ignore.txt
+2
-2
@@ -9,8 +9,8 @@ git-check-ignore - Debug gitignore / exclude files
9
SYNOPSIS
10
--------
11
[verse]
12
-'git check-ignore' [options] pathname...
13
-'git check-ignore' [options] --stdin
12
+'git check-ignore' [<options>] <pathname>...
13
+'git check-ignore' [<options>] --stdin
14
15
DESCRIPTION
16
-----------
Documentation/git-check-mailmap.txt
+1
-1
@@ -9,7 +9,7 @@ git-check-mailmap - Show canonical names and email addresses of contacts
9
SYNOPSIS
10
--------
11
[verse]
12
-'git check-mailmap' [options] <contact>...
12
+'git check-mailmap' [<options>] <contact>...
13
14
15
DESCRIPTION
Documentation/git-credential-cache.txt
+1
-1
@@ -8,7 +8,7 @@ git-credential-cache - Helper to temporarily store passwords in memory
8
SYNOPSIS
9
--------
10
-----------------------------
11
-git config credential.helper 'cache [options]'
11
+git config credential.helper 'cache [<options>]'
12
-----------------------------
13
14
DESCRIPTION
Documentation/git-credential-store.txt
+1
-1
@@ -8,7 +8,7 @@ git-credential-store - Helper to store credentials on disk
8
SYNOPSIS
9
--------
10
-------------------
11
-git config credential.helper 'store [options]'
11
+git config credential.helper 'store [<options>]'
12
-------------------
13
14
DESCRIPTION
Documentation/git-cvsserver.txt
+1
-1
@@ -22,7 +22,7 @@ cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
22
Usage:
23
24
[verse]
25
-'git-cvsserver' [options] [pserver|server] [<directory> ...]
25
+'git-cvsserver' [<options>] [pserver|server] [<directory> ...]
26
27
OPTIONS
28
-------
Documentation/git-diff.txt
+13
-13
@@ -9,11 +9,11 @@ git-diff - Show changes between commits, commit and working tree, etc
9
SYNOPSIS
10
--------
11
[verse]
12
-'git diff' [options] [<commit>] [--] [<path>...]
13
-'git diff' [options] --cached [<commit>] [--] [<path>...]
14
-'git diff' [options] <commit> <commit> [--] [<path>...]
15
-'git diff' [options] <blob> <blob>
16
-'git diff' [options] --no-index [--] <path> <path>
12
+'git diff' [<options>] [<commit>] [--] [<path>...]
13
+'git diff' [<options>] --cached [<commit>] [--] [<path>...]
14
+'git diff' [<options>] <commit> <commit> [--] [<path>...]
15
+'git diff' [<options>] <blob> <blob>
16
+'git diff' [<options>] --no-index [--] <path> <path>
17
18
DESCRIPTION
19
-----------
@@ -21,7 +21,7 @@ Show changes between the working tree and the index or a tree, changes
21
between the index and a tree, changes between two trees, changes between
22
two blob objects, or changes between two files on disk.
23
24
-'git diff' [options] [--] [<path>...]::
24
+'git diff' [<options>] [--] [<path>...]::
25
26
This form is to view the changes you made relative to
27
the index (staging area for the next commit). In other
@@ -29,7 +29,7 @@ two blob objects, or changes between two files on disk.
29
further add to the index but you still haven't. You can
30
stage these changes by using linkgit:git-add[1].
31
32
-'git diff' [options] --no-index [--] <path> <path>::
32
+'git diff' [<options>] --no-index [--] <path> <path>::
33
34
This form is to compare the given two paths on the
35
filesystem. You can omit the `--no-index` option when
@@ -38,7 +38,7 @@ two blob objects, or changes between two files on disk.
38
or when running the command outside a working tree
39
controlled by Git.
40
41
-'git diff' [options] --cached [<commit>] [--] [<path>...]::
41
+'git diff' [<options>] --cached [<commit>] [--] [<path>...]::
42
43
This form is to view the changes you staged for the next
44
commit relative to the named <commit>. Typically you
@@ -48,7 +48,7 @@ two blob objects, or changes between two files on disk.
48
<commit> is not given, it shows all staged changes.
49
--staged is a synonym of --cached.
50
51
-'git diff' [options] <commit> [--] [<path>...]::
51
+'git diff' [<options>] <commit> [--] [<path>...]::
52
53
This form is to view the changes you have in your
54
working tree relative to the named <commit>. You can
@@ -56,18 +56,18 @@ two blob objects, or changes between two files on disk.
56
branch name to compare with the tip of a different
57
branch.
58
59
-'git diff' [options] <commit> <commit> [--] [<path>...]::
59
+'git diff' [<options>] <commit> <commit> [--] [<path>...]::
60
61
This is to view the changes between two arbitrary
62
<commit>.
63
64
-'git diff' [options] <commit>..<commit> [--] [<path>...]::
64
+'git diff' [<options>] <commit>..<commit> [--] [<path>...]::
65
66
This is synonymous to the previous form. If <commit> on
67
one side is omitted, it will have the same effect as
68
using HEAD instead.
69
70
-'git diff' [options] <commit>\...<commit> [--] [<path>...]::
70
+'git diff' [<options>] <commit>\...<commit> [--] [<path>...]::
71
72
This form is to view the changes on the branch containing
73
and up to the second <commit>, starting at a common ancestor
@@ -87,7 +87,7 @@ and the range notations ("<commit>..<commit>" and
87
"<commit>\...<commit>") do not mean a range as defined in the
88
"SPECIFYING RANGES" section in linkgit:gitrevisions[7].
89
90
-'git diff' [options] <blob> <blob>::
90
+'git diff' [<options>] <blob> <blob>::
91
92
This form is to view the differences between the raw
93
contents of two blob objects.
Documentation/git-fast-export.txt
+1
-1
@@ -9,7 +9,7 @@ git-fast-export - Git data exporter
9
SYNOPSIS
10
--------
11
[verse]
12
-'git fast-export [options]' | 'git fast-import'
12
+'git fast-export [<options>]' | 'git fast-import'
13
14
DESCRIPTION
15
-----------
Documentation/git-fast-import.txt
+1
-1
@@ -9,7 +9,7 @@ git-fast-import - Backend for fast Git data importers
9
SYNOPSIS
10
--------
11
[verse]
12
-frontend | 'git fast-import' [options]
12
+frontend | 'git fast-import' [<options>]
13
14
DESCRIPTION
15
-----------
Documentation/git-interpret-trailers.txt
+2
-2
@@ -8,8 +8,8 @@ git-interpret-trailers - add or parse structured information in commit messages
8
SYNOPSIS
9
--------
10
[verse]
11
-'git interpret-trailers' [options] [(--trailer <token>[(=|:)<value>])...] [<file>...]
12
-'git interpret-trailers' [options] [--parse] [<file>...]
11
+'git interpret-trailers' [<options>] [(--trailer <token>[(=|:)<value>])...] [<file>...]
12
+'git interpret-trailers' [<options>] [--parse] [<file>...]
13
14
DESCRIPTION
15
-----------
Documentation/git-pull.txt
+1
-1
@@ -9,7 +9,7 @@ git-pull - Fetch from and integrate with another repository or a local branch
9
SYNOPSIS
10
--------
11
[verse]
12
-'git pull' [options] [<repository> [<refspec>...]]
12
+'git pull' [<options>] [<repository> [<refspec>...]]
13
14
15
DESCRIPTION
Documentation/git-rebase.txt
+2
-2
@@ -8,9 +8,9 @@ git-rebase - Reapply commits on top of another base tip
8
SYNOPSIS
9
--------
10
[verse]
11
-'git rebase' [-i | --interactive] [options] [--exec <cmd>] [--onto <newbase>]
11
+'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
12
[<upstream> [<branch>]]
13
-'git rebase' [-i | --interactive] [options] [--exec <cmd>] [--onto <newbase>]
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
16
Documentation/git-rev-parse.txt
+3
-3
@@ -9,7 +9,7 @@ git-rev-parse - Pick out and massage parameters
9
SYNOPSIS
10
--------
11
[verse]
12
-'git rev-parse' [ --option ] <args>...
12
+'git rev-parse' [<options>] <args>...
13
14
DESCRIPTION
15
-----------
@@ -360,7 +360,7 @@ Example
360
361
------------
362
OPTS_SPEC="\
363
-some-command [options] <args>...
363
+some-command [<options>] <args>...
364
365
some-command does foo and bar!
366
--
@@ -385,7 +385,7 @@ When `"$@"` is `-h` or `--help` in the above example, the following
385
usage text would be shown:
386
387
------------
388
-usage: some-command [options] <args>...
388
+usage: some-command [<options>] <args>...
389
390
some-command does foo and bar!
391
Documentation/git-send-email.txt
+1
-1
@@ -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|rev-list options>...
12
+'git send-email' [<options>] <file|directory|rev-list options>...
13
'git send-email' --dump-aliases
14
15
Documentation/git-show.txt
+1
-1
@@ -9,7 +9,7 @@ git-show - Show various types of objects
9
SYNOPSIS
10
--------
11
[verse]
12
-'git show' [options] [<object>...]
12
+'git show' [<options>] [<object>...]
13
14
DESCRIPTION
15
-----------
Documentation/git-svn.txt
+1
-1
@@ -8,7 +8,7 @@ git-svn - Bidirectional operation between a Subversion repository and Git
8
SYNOPSIS
9
--------
10
[verse]
11
-'git svn' <command> [options] [arguments]
11
+'git svn' <command> [<options>] [<arguments>]
12
13
DESCRIPTION
14
-----------
Documentation/git-web--browse.txt
+1
-1
@@ -8,7 +8,7 @@ git-web--browse - Git helper script to launch a web browser
8
SYNOPSIS
9
--------
10
[verse]
11
-'git web{litdd}browse' [OPTIONS] URL/FILE ...
11
+'git web{litdd}browse' [<options>] <url|file>...
12
13
DESCRIPTION
14
-----------
Documentation/gitcli.txt
+2
-2
@@ -110,8 +110,8 @@ couple of magic command-line options:
110
+
111
---------------------------------------------
112
$ git describe -h
113
-usage: git describe [options] <commit-ish>*
114
- or: git describe [options] --dirty
113
+usage: git describe [<options>] <commit-ish>*
114
+ or: git describe [<options>] --dirty
115
116
--contains find the tag that comes after the commit
117
--debug debug search strategy on stderr