Skip to content

Commit de2852a

Browse files
jnavilagitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent f41f85c commit de2852a

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

Documentation/git-rev-parse.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ git-rev-parse - Pick out and massage parameters
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git rev-parse' [<options>] <args>...
12+
'git rev-parse' [<options>] <arg>...
1313

1414
DESCRIPTION
1515
-----------
@@ -130,7 +130,7 @@ for another option.
130130
'git diff-{asterisk}'). In contrast to the `--sq-quote` option,
131131
the command input is still interpreted as usual.
132132

133-
--short[=length]::
133+
--short[=<length>]::
134134
Same as `--verify` but shortens the object name to a unique
135135
prefix with at least `length` characters. The minimum length
136136
is 4, the default is the effective value of the `core.abbrev`
@@ -165,9 +165,9 @@ Options for Objects
165165
--all::
166166
Show all refs found in `refs/`.
167167

168-
--branches[=pattern]::
169-
--tags[=pattern]::
170-
--remotes[=pattern]::
168+
--branches[=<pattern>]::
169+
--tags[=<pattern>]::
170+
--remotes[=<pattern>]::
171171
Show all branches, tags, or remote-tracking branches,
172172
respectively (i.e., refs found in `refs/heads`,
173173
`refs/tags`, or `refs/remotes`, respectively).
@@ -176,7 +176,7 @@ If a `pattern` is given, only refs matching the given shell glob are
176176
shown. If the pattern does not contain a globbing character (`?`,
177177
`*`, or `[`), it is turned into a prefix match by appending `/*`.
178178

179-
--glob=pattern::
179+
--glob=<pattern>::
180180
Show all refs matching the shell glob pattern `pattern`. If
181181
the pattern does not start with `refs/`, this is automatically
182182
prepended. If the pattern does not contain a globbing
@@ -197,7 +197,7 @@ respectively, and they must begin with `refs/` when applied to `--glob`
197197
or `--all`. If a trailing '/{asterisk}' is intended, it must be given
198198
explicitly.
199199

200-
--exclude-hidden=[fetch|receive|uploadpack]::
200+
--exclude-hidden=(fetch|receive|uploadpack)::
201201
Do not include refs that would be hidden by `git-fetch`,
202202
`git-receive-pack` or `git-upload-pack` by consulting the appropriate
203203
`fetch.hideRefs`, `receive.hideRefs` or `uploadpack.hideRefs`
@@ -314,17 +314,17 @@ The following options are unaffected by `--path-format`:
314314
Other Options
315315
~~~~~~~~~~~~~
316316

317-
--since=datestring::
318-
--after=datestring::
317+
--since=<datestring>::
318+
--after=<datestring>::
319319
Parse the date string, and output the corresponding
320320
--max-age= parameter for 'git rev-list'.
321321

322-
--until=datestring::
323-
--before=datestring::
322+
--until=<datestring>::
323+
--before=<datestring>::
324324
Parse the date string, and output the corresponding
325325
--min-age= parameter for 'git rev-list'.
326326

327-
<args>...::
327+
<arg>...::
328328
Flags and parameters to be parsed.
329329

330330

0 commit comments

Comments
 (0)