Skip to content

Commit 7659bda

Browse files
gitstergitster
committed
Merge branch 'rd/doc-options-placeholder'
Docfix. * rd/doc-options-placeholder: Use proper syntax for replaceables in command docs
2 parents 7cb4a97 + de61305 commit 7659bda

19 files changed

+38
-38
lines changed

‎Documentation/git-annotate.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-annotate - Annotate file lines with commit information
88
SYNOPSIS
99
--------
1010
[verse]
11-
'git annotate' [options] file [revision]
11+
'git annotate' [<options>] <file> [<revision>]
1212

1313
DESCRIPTION
1414
-----------

‎Documentation/git-check-attr.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ git-check-attr - Display gitattributes information
99
SYNOPSIS
1010
--------
1111
[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>...]
1414

1515
DESCRIPTION
1616
-----------

‎Documentation/git-check-ignore.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ git-check-ignore - Debug gitignore / exclude files
99
SYNOPSIS
1010
--------
1111
[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
1414

1515
DESCRIPTION
1616
-----------

‎Documentation/git-check-mailmap.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-check-mailmap - Show canonical names and email addresses of contacts
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git check-mailmap' [options] <contact>...
12+
'git check-mailmap' [<options>] <contact>...
1313

1414

1515
DESCRIPTION

‎Documentation/git-credential-cache.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-credential-cache - Helper to temporarily store passwords in memory
88
SYNOPSIS
99
--------
1010
-----------------------------
11-
git config credential.helper 'cache [options]'
11+
git config credential.helper 'cache [<options>]'
1212
-----------------------------
1313

1414
DESCRIPTION

‎Documentation/git-credential-store.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-credential-store - Helper to store credentials on disk
88
SYNOPSIS
99
--------
1010
-------------------
11-
git config credential.helper 'store [options]'
11+
git config credential.helper 'store [<options>]'
1212
-------------------
1313

1414
DESCRIPTION

‎Documentation/git-cvsserver.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
2222
Usage:
2323

2424
[verse]
25-
'git-cvsserver' [options] [pserver|server] [<directory> ...]
25+
'git-cvsserver' [<options>] [pserver|server] [<directory> ...]
2626

2727
OPTIONS
2828
-------

‎Documentation/git-diff.txt

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,27 @@ git-diff - Show changes between commits, commit and working tree, etc
99
SYNOPSIS
1010
--------
1111
[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>
1717

1818
DESCRIPTION
1919
-----------
2020
Show changes between the working tree and the index or a tree, changes
2121
between the index and a tree, changes between two trees, changes between
2222
two blob objects, or changes between two files on disk.
2323

24-
'git diff' [options] [--] [<path>...]::
24+
'git diff' [<options>] [--] [<path>...]::
2525

2626
This form is to view the changes you made relative to
2727
the index (staging area for the next commit). In other
2828
words, the differences are what you _could_ tell Git to
2929
further add to the index but you still haven't. You can
3030
stage these changes by using linkgit:git-add[1].
3131

32-
'git diff' [options] --no-index [--] <path> <path>::
32+
'git diff' [<options>] --no-index [--] <path> <path>::
3333

3434
This form is to compare the given two paths on the
3535
filesystem. You can omit the `--no-index` option when
@@ -38,7 +38,7 @@ two blob objects, or changes between two files on disk.
3838
or when running the command outside a working tree
3939
controlled by Git.
4040

41-
'git diff' [options] --cached [<commit>] [--] [<path>...]::
41+
'git diff' [<options>] --cached [<commit>] [--] [<path>...]::
4242

4343
This form is to view the changes you staged for the next
4444
commit relative to the named <commit>. Typically you
@@ -48,26 +48,26 @@ two blob objects, or changes between two files on disk.
4848
<commit> is not given, it shows all staged changes.
4949
--staged is a synonym of --cached.
5050

51-
'git diff' [options] <commit> [--] [<path>...]::
51+
'git diff' [<options>] <commit> [--] [<path>...]::
5252

5353
This form is to view the changes you have in your
5454
working tree relative to the named <commit>. You can
5555
use HEAD to compare it with the latest commit, or a
5656
branch name to compare with the tip of a different
5757
branch.
5858

59-
'git diff' [options] <commit> <commit> [--] [<path>...]::
59+
'git diff' [<options>] <commit> <commit> [--] [<path>...]::
6060

6161
This is to view the changes between two arbitrary
6262
<commit>.
6363

64-
'git diff' [options] <commit>..<commit> [--] [<path>...]::
64+
'git diff' [<options>] <commit>..<commit> [--] [<path>...]::
6565

6666
This is synonymous to the previous form. If <commit> on
6767
one side is omitted, it will have the same effect as
6868
using HEAD instead.
6969

70-
'git diff' [options] <commit>\...<commit> [--] [<path>...]::
70+
'git diff' [<options>] <commit>\...<commit> [--] [<path>...]::
7171

7272
This form is to view the changes on the branch containing
7373
and up to the second <commit>, starting at a common ancestor
@@ -87,7 +87,7 @@ and the range notations ("<commit>..<commit>" and
8787
"<commit>\...<commit>") do not mean a range as defined in the
8888
"SPECIFYING RANGES" section in linkgit:gitrevisions[7].
8989

90-
'git diff' [options] <blob> <blob>::
90+
'git diff' [<options>] <blob> <blob>::
9191

9292
This form is to view the differences between the raw
9393
contents of two blob objects.

‎Documentation/git-fast-export.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-fast-export - Git data exporter
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git fast-export [options]' | 'git fast-import'
12+
'git fast-export [<options>]' | 'git fast-import'
1313

1414
DESCRIPTION
1515
-----------

‎Documentation/git-fast-import.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-fast-import - Backend for fast Git data importers
99
SYNOPSIS
1010
--------
1111
[verse]
12-
frontend | 'git fast-import' [options]
12+
frontend | 'git fast-import' [<options>]
1313

1414
DESCRIPTION
1515
-----------

0 commit comments

Comments
 (0)