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/git-rev-parse.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/git-rev-parse.txt')
| -rw-r--r-- | Documentation/git-rev-parse.txt | 6 |
1 files changed, 3 insertions, 3 deletions
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 ] <args>... +'git rev-parse' [<options>] <args>... DESCRIPTION ----------- @@ -360,7 +360,7 @@ Example ------------ OPTS_SPEC="\ -some-command [options] <args>... +some-command [<options>] <args>... 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] <args>... +usage: some-command [<options>] <args>... some-command does foo and bar! |