]> git.ipfire.org Git - thirdparty/git.git/commitdiff
for-each-ref: fix documentation argument ordering
authorKarthik Nayak <karthik.188@gmail.com>
Mon, 28 Jul 2025 20:20:47 +0000 (22:20 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 28 Jul 2025 21:16:37 +0000 (14:16 -0700)
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 <karthik.188@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-for-each-ref.adoc

index ae61ba642a63899f9ee58e019b9b3d6525b3af16..ec3b10e14a29c24d5ad00732c1b07b836b13f393 100644 (file)
@@ -7,14 +7,14 @@ git-for-each-ref - Output information on each ref
 
 SYNOPSIS
 --------
-[verse]
-'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
+[synopsis]
+git for-each-ref [--count=<count>] [--shell|--perl|--python|--tcl]
                   [(--sort=<key>)...] [--format=<format>]
-                  [--include-root-refs] [ --stdin | <pattern>... ]
-                  [--points-at=<object>]
+                  [--include-root-refs] [--points-at=<object>]
                   [--merged[=<object>]] [--no-merged[=<object>]]
                   [--contains[=<object>]] [--no-contains[=<object>]]
-                  [--exclude=<pattern> ...] [--start-after=<marker>]
+                  [(--exclude=<pattern>)...] [--start-after=<marker>]
+                  [ --stdin | <pattern>... ]
 
 DESCRIPTION
 -----------