diff options
| author | Karthik Nayak <karthik.188@gmail.com> | 2025-07-28 22:20:47 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-07-28 14:16:37 -0700 |
| commit | a7c8a4c5f5bbe6c232c8aefc02499fe1c0b6d221 (patch) | |
| tree | c115083d54fb983cbc434cbb8885d2e3428d1888 | |
| parent | 65855751d190d66d15bc2c7e17e93fe00d04c539 (diff) | |
| download | git-a7c8a4c5f5bbe6c232c8aefc02499fe1c0b6d221.tar.gz | |
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 <karthik.188@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-for-each-ref.adoc | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/git-for-each-ref.adoc b/Documentation/git-for-each-ref.adoc index ae61ba642a..ec3b10e14a 100644 --- a/Documentation/git-for-each-ref.adoc +++ b/Documentation/git-for-each-ref.adoc @@ -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 ----------- |