diff options
| author | Robert P. J. Day <rpjday@crashcourse.ca> | 2018-05-24 16:11:39 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2018-05-25 17:16:47 +0900 |
| commit | de613050efec781e8380a0267879a25b2d489513 (patch) | |
| tree | 99043c9bc9133f45b042c7b80dc509d434e5657e /Documentation/gitcli.txt | |
| parent | e144d126d74f5d2702870ca9423743102eec6fcd (diff) | |
| download | git-de613050efec781e8380a0267879a25b2d489513.tar.gz | |
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>
Diffstat (limited to 'Documentation/gitcli.txt')
| -rw-r--r-- | Documentation/gitcli.txt | 4 |
1 files changed, 2 insertions, 2 deletions
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] <commit-ish>* - or: git describe [options] --dirty +usage: git describe [<options>] <commit-ish>* + or: git describe [<options>] --dirty --contains find the tag that comes after the commit --debug debug search strategy on stderr |