git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Karthik Nayak <karthik.188@gmail.com>
To: git@vger.kernel.org
Cc: Karthik Nayak <karthik.188@gmail.com>
Subject: [PATCH 2/5] for-each-ref: fix documentation argument ordering
Date: Thu, 24 Jul 2025 10:14:43 +0200	[thread overview]
Message-ID: <20250724-kn-small-cleanups-v1-2-0c70f591de3e@gmail.com> (raw)
In-Reply-To: <20250724-kn-small-cleanups-v1-0-0c70f591de3e@gmail.com>

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.

Signed-off-by: Karthik Nayak <karthik.188@gmail.com>
---
 Documentation/git-for-each-ref.adoc | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-for-each-ref.adoc b/Documentation/git-for-each-ref.adoc
index ae61ba642a..a170de4209 100644
--- a/Documentation/git-for-each-ref.adoc
+++ b/Documentation/git-for-each-ref.adoc
@@ -10,11 +10,11 @@ SYNOPSIS
 [verse]
 '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
 -----------

-- 
2.49.0


  parent reply	other threads:[~2025-07-24  8:14 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-24  8:14 [PATCH 0/5] ref-filter: small cleanups and fixes Karthik Nayak
2025-07-24  8:14 ` [PATCH 1/5] ref-cache: use 'size_t' instead of int for length Karthik Nayak
2025-07-24 17:17   ` Junio C Hamano
2025-07-24  8:14 ` Karthik Nayak [this message]
2025-07-24 17:27   ` [PATCH 2/5] for-each-ref: fix documentation argument ordering Junio C Hamano
2025-07-24 22:14     ` Karthik Nayak
2025-07-24 22:32       ` Junio C Hamano
2025-07-28 20:19         ` Karthik Nayak
2025-07-25 10:55   ` Patrick Steinhardt
2025-07-28 20:18     ` Karthik Nayak
2025-07-24  8:14 ` [PATCH 3/5] for-each-ref: reword the documentation for '--start-after' Karthik Nayak
2025-07-25 10:55   ` Patrick Steinhardt
2025-07-24  8:14 ` [PATCH 4/5] t6302: add test combining '--start-after' with '--exclude' Karthik Nayak
2025-07-24  8:14 ` [PATCH 5/5] ref-filter: use REF_ITERATOR_SEEK_SET_PREFIX instead of '1' Karthik Nayak
2025-07-24 17:41 ` [PATCH 0/5] ref-filter: small cleanups and fixes Junio C Hamano
2025-07-28 20:20 ` [PATCH v2 " Karthik Nayak
2025-07-28 20:20   ` [PATCH v2 1/5] ref-cache: use 'size_t' instead of int for length Karthik Nayak
2025-07-28 20:20   ` [PATCH v2 2/5] for-each-ref: fix documentation argument ordering Karthik Nayak
2025-07-28 20:20   ` [PATCH v2 3/5] for-each-ref: reword the documentation for '--start-after' Karthik Nayak
2025-07-28 20:20   ` [PATCH v2 4/5] t6302: add test combining '--start-after' with '--exclude' Karthik Nayak
2025-07-28 20:20   ` [PATCH v2 5/5] ref-filter: use REF_ITERATOR_SEEK_SET_PREFIX instead of '1' Karthik Nayak
2025-07-29  8:04   ` [PATCH v2 0/5] ref-filter: small cleanups and fixes Patrick Steinhardt

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250724-kn-small-cleanups-v1-2-0c70f591de3e@gmail.com \
    --to=karthik.188@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).