From: Dirk Gouders <dirk@gouders.net>
To: git@vger.kernel.org
Cc: Dirk Gouders <dirk@gouders.net>
Subject: [PATCH v2] doc/gitcli: minor fixes
Date: Sat, 14 Nov 2026 23:23:37 +0100 [thread overview]
Message-ID: <20261114222411.105592-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>
---
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
--
2.55.0
prev parent reply other threads:[~2026-11-14 22:24 UTC|newest]
Thread overview: 4+ 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 ` 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=20261114222411.105592-1-dirk@gouders.net \
--to=dirk@gouders.net \
--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