From: Dirk Gouders <dirk@gouders.net>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Dirk Gouders <dirk@gouders.net>
Subject: [PATCH v3] doc/gitcli: minor fixes
Date: Sun, 15 Nov 2026 08:03:37 +0100 [thread overview]
Message-ID: <20261115070357.113875-1-dirk@gouders.net> (raw)
In-Reply-To: <20261114201632.103400-1-dirk@gouders.net>
Fix three details in the gitcli documentation:
Use plural/singular where appropriate and imperative form when rules
are listed.
Signed-off-by: Dirk Gouders <dirk@gouders.net>
---
Please disregard v2, I forgot to Cc the reviewer and to add the range-diff.
Changes in v3:
- Resent with proper Cc and range-diff against v1.
Changes in v2:
- Addressed feedback on the second part of the change.
Documentation/gitcli.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/gitcli.adoc b/Documentation/gitcli.adoc
index 9c4598e29c..454c482a50 100644
--- a/Documentation/gitcli.adoc
+++ b/Documentation/gitcli.adoc
@@ -8,7 +8,7 @@ gitcli - Git command-line interface and conventions
DESCRIPTION
-----------
-This manual describes the convention used throughout Git CLI.
+This manual describes the conventions used throughout Git CLI.
Many commands take revisions (most often "commits", but sometimes
"tree-ish", depending on the context and command) and paths as their
@@ -29,7 +29,7 @@ arguments. Here are the rules:
are paths.
* When an argument can be misunderstood as either a revision or a path,
- they can be disambiguated by placing `--` between them.
+ it can be disambiguated by placing `--` before or after it.
E.g. `git diff -- HEAD` is, "I have a file called HEAD in my work
tree. Please show changes between the version I staged in the index
and what I have in the work tree for that file", not "show the difference
@@ -76,8 +76,8 @@ you will.
Here are the rules regarding the "flags" that you should follow when you are
scripting Git:
- * Splitting short options to separate words (prefer `git foo -a -b`
- to `git foo -ab`, the latter may not even work).
+ * Split short options to separate words: prefer `git foo -a -b`
+ to `git foo -ab` (the latter may not even work).
* When a command-line option takes an argument, use the 'stuck' form. In
other words, write `git foo -oArg` instead of `git foo -o Arg` for short
Range-diff against v1:
1: 1393397087 ! 1: 7f44bbde6b doc/gitcli: minor fixes
@@ Commit message
Fix three details in the gitcli documentation:
- Use plural where appropriate and imperative form when rules are
- listed.
+ Use plural/singular where appropriate and imperative form when rules
+ are listed.
Signed-off-by: Dirk Gouders <dirk@gouders.net>
@@ Documentation/gitcli.adoc: gitcli - Git command-line interface and conventions
Many commands take revisions (most often "commits", but sometimes
"tree-ish", depending on the context and command) and paths as their
@@ Documentation/gitcli.adoc: arguments. Here are the rules:
- `v1.0` and `v2.0` are revisions and `arch/x86` and `include/asm-x86`
are paths.
-- * When an argument can be misunderstood as either a revision or a path,
-+ * When arguments can be misunderstood as either a revision or a path,
- they can be disambiguated by placing `--` between them.
+ * When an argument can be misunderstood as either a revision or a path,
+- they can be disambiguated by placing `--` between them.
++ it can be disambiguated by placing `--` before or after it.
E.g. `git diff -- HEAD` is, "I have a file called HEAD in my work
tree. Please show changes between the version I staged in the index
+ and what I have in the work tree for that file", not "show the difference
@@ Documentation/gitcli.adoc: you will.
Here are the rules regarding the "flags" that you should follow when you are
scripting Git:
--
2.55.0
prev parent reply other threads:[~2026-11-15 7:04 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-14 20:15 [PATCH 1/1] doc/gitcli: minor fixes Dirk Gouders
2026-11-14 21:55 ` Junio C Hamano
2026-11-14 22:09 ` Dirk Gouders
2026-11-14 22:23 ` [PATCH v2] " Dirk Gouders
2026-11-15 7:03 ` Dirk Gouders [this message]
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=20261115070357.113875-1-dirk@gouders.net \
--to=dirk@gouders.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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