* [PATCH 1/1] doc/gitcli: minor fixes
@ 2026-11-14 20:15 Dirk Gouders
0 siblings, 0 replies; only message in thread
From: Dirk Gouders @ 2026-11-14 20:15 UTC (permalink / raw)
To: git; +Cc: Dirk Gouders
Fix three details in the gitcli documentation:
Use plural 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..6b0a58938a 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
@@ -28,7 +28,7 @@ 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.
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
@@ -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
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2026-11-14 20:16 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-14 20:15 [PATCH 1/1] doc/gitcli: minor fixes Dirk Gouders
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox