public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: "D. Ben Knoble" <ben.knoble+github@gmail•com>
To: git@vger•kernel.org
Cc: "D. Ben Knoble" <ben.knoble+github@gmail•com>,
	Phillip Wood <phillip.wood@dunelm•org.uk>,
	Taylor Blau <me@ttaylorr•com>, Junio C Hamano <gitster@pobox•com>
Subject: [PATCH 2/5] doc: clarify command equivalence comment
Date: Sun,  2 Nov 2025 11:17:45 -0500	[thread overview]
Message-ID: <30908830025a3004fa34080793b610b5fe1eef9e.1762100242.git.ben.knoble+github@gmail.com> (raw)
In-Reply-To: <cover.1762100242.git.ben.knoble+github@gmail.com>

Documentation of command parsing for :(optional) includes a terse
comment; expand it to be clearer to readers.

Suggested-by: Phillip Wood <phillip.wood@dunelm•org.uk>
Signed-off-by: D. Ben Knoble <ben.knoble+github@gmail•com>
---
 Documentation/gitcli.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/gitcli.adoc b/Documentation/gitcli.adoc
index ef2a0a399d..6815d6bfb7 100644
--- a/Documentation/gitcli.adoc
+++ b/Documentation/gitcli.adoc
@@ -223,7 +223,7 @@ Options that take a filename allow a prefix `:(optional)`. For example:
 
 ----------------------------
 git commit -F :(optional)COMMIT_EDITMSG
-# if COMMIT_EDITMSG does not exist, equivalent to
+# if COMMIT_EDITMSG does not exist, the above is equivalent to
 git commit
 ----------------------------
 
-- 
2.48.1


  parent reply	other threads:[~2025-11-02 16:18 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-02 16:17 [PATCH 0/5] Fixes for :(optional) path code D. Ben Knoble
2025-11-02 16:17 ` [PATCH 1/5] parseopt: fix :(optional) at command line to only ignore missing files D. Ben Knoble
2025-11-04 16:19   ` Phillip Wood
2025-11-04 17:24     ` Junio C Hamano
2025-11-04 17:34       ` Junio C Hamano
2025-11-04 18:24         ` D. Ben Knoble
2025-11-05 16:35         ` Phillip Wood
2025-11-06 17:47           ` Junio C Hamano
2025-11-02 16:17 ` D. Ben Knoble [this message]
2025-11-02 16:17 ` [PATCH 3/5] parseopt: use boolean type for a simple flag D. Ben Knoble
2025-11-03  5:19   ` Junio C Hamano
2025-11-04 16:21     ` Phillip Wood
2025-11-04 18:22       ` D. Ben Knoble
2025-11-02 16:17 ` [PATCH 4/5] config: " D. Ben Knoble
2025-11-02 16:17 ` [PATCH 5/5] parseopt: restore const qualifier to parsed filename D. Ben Knoble

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=30908830025a3004fa34080793b610b5fe1eef9e.1762100242.git.ben.knoble+github@gmail.com \
    --to=ben.knoble+github@gmail$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=gitster@pobox$(echo .)com \
    --cc=me@ttaylorr$(echo .)com \
    --cc=phillip.wood@dunelm$(echo .)org.uk \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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