]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: clarify command equivalence comment
authorD. Ben Knoble <ben.knoble+github@gmail.com>
Sun, 2 Nov 2025 16:17:45 +0000 (11:17 -0500)
committerJunio C Hamano <gitster@pobox.com>
Tue, 4 Nov 2025 17:25:51 +0000 (09:25 -0800)
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/gitcli.adoc

index ef2a0a399dc97488f8b1b8d5d798703c7c5ee069..6815d6bfb78d222606d7e0124a1be798b72c2f73 100644 (file)
@@ -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
 ----------------------------