doc: git-rev-parse: enforce command-line description syntax
git-rev-parse(1) manpage is completely off with respect to the command-line description syntax with badly formatted placeholders and malformed alternatives. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
Feb 20, 2024 at 22:32 UTC
de2852ab6fecad63e41982823436e66ffa3fb3a2
1 file changed
+12
-12
Documentation/git-rev-parse.txt
+12
-12
@@ -9,7 +9,7 @@ git-rev-parse - Pick out and massage parameters
9
SYNOPSIS
10
--------
11
[verse]
12
-'git rev-parse' [<options>] <args>...
12
+'git rev-parse' [<options>] <arg>...
13
14
DESCRIPTION
15
-----------
@@ -130,7 +130,7 @@ for another option.
130
'git diff-{asterisk}'). In contrast to the `--sq-quote` option,
131
the command input is still interpreted as usual.
132
133
---short[=length]::
133
+--short[=<length>]::
134
Same as `--verify` but shortens the object name to a unique
135
prefix with at least `length` characters. The minimum length
136
is 4, the default is the effective value of the `core.abbrev`
@@ -165,9 +165,9 @@ Options for Objects
165
--all::
166
Show all refs found in `refs/`.
167
168
---branches[=pattern]::
169
---tags[=pattern]::
170
---remotes[=pattern]::
168
+--branches[=<pattern>]::
169
+--tags[=<pattern>]::
170
+--remotes[=<pattern>]::
171
Show all branches, tags, or remote-tracking branches,
172
respectively (i.e., refs found in `refs/heads`,
173
`refs/tags`, or `refs/remotes`, respectively).
@@ -176,7 +176,7 @@ If a `pattern` is given, only refs matching the given shell glob are
176
shown. If the pattern does not contain a globbing character (`?`,
177
`*`, or `[`), it is turned into a prefix match by appending `/*`.
178
179
---glob=pattern::
179
+--glob=<pattern>::
180
Show all refs matching the shell glob pattern `pattern`. If
181
the pattern does not start with `refs/`, this is automatically
182
prepended. If the pattern does not contain a globbing
@@ -197,7 +197,7 @@ respectively, and they must begin with `refs/` when applied to `--glob`
197
or `--all`. If a trailing '/{asterisk}' is intended, it must be given
198
explicitly.
199
200
---exclude-hidden=[fetch|receive|uploadpack]::
200
+--exclude-hidden=(fetch|receive|uploadpack)::
201
Do not include refs that would be hidden by `git-fetch`,
202
`git-receive-pack` or `git-upload-pack` by consulting the appropriate
203
`fetch.hideRefs`, `receive.hideRefs` or `uploadpack.hideRefs`
@@ -314,17 +314,17 @@ The following options are unaffected by `--path-format`:
314
Other Options
315
~~~~~~~~~~~~~
316
317
---since=datestring::
318
---after=datestring::
317
+--since=<datestring>::
318
+--after=<datestring>::
319
Parse the date string, and output the corresponding
320
--max-age= parameter for 'git rev-list'.
321
322
---until=datestring::
323
---before=datestring::
322
+--until=<datestring>::
323
+--before=<datestring>::
324
Parse the date string, and output the corresponding
325
--min-age= parameter for 'git rev-list'.
326
327
-<args>...::
327
+<arg>...::
328
Flags and parameters to be parsed.
329
330