Skip to content

Commit a7c8a4c

Browse files
KarthikNayakgitster
authored andcommitted
for-each-ref: fix documentation argument ordering
Improve the 'git-for-each-ref(1)' documentation with two corrections: 1. Add parentheses around `--exclude=<pattern>` to indicate this option can be repeated as a complete unit. 2. Move `--stdin | <pattern> ...` to the end, after all flags, since `<pattern>` is a positional argument that should appear last in the argument list. While here, change to using the synopsis block which will automatically format placeholders in italics and keywords in monospace. Signed-off-by: Karthik Nayak <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 6585575 commit a7c8a4c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Documentation/git-for-each-ref.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ git-for-each-ref - Output information on each ref
77

88
SYNOPSIS
99
--------
10-
[verse]
11-
'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
10+
[synopsis]
11+
git for-each-ref [--count=<count>] [--shell|--perl|--python|--tcl]
1212
[(--sort=<key>)...] [--format=<format>]
13-
[--include-root-refs] [ --stdin | <pattern>... ]
14-
[--points-at=<object>]
13+
[--include-root-refs] [--points-at=<object>]
1514
[--merged[=<object>]] [--no-merged[=<object>]]
1615
[--contains[=<object>]] [--no-contains[=<object>]]
17-
[--exclude=<pattern> ...] [--start-after=<marker>]
16+
[(--exclude=<pattern>)...] [--start-after=<marker>]
17+
[ --stdin | <pattern>... ]
1818

1919
DESCRIPTION
2020
-----------

0 commit comments

Comments
 (0)