git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v3] doc/gitcli: minor fixes

From
Dirk Gouders <dirk@gouders.net>
Date
Nov 15, 2026, 07:03 UTC
Message-ID
<20261115070357.113875-1-dirk@gouders.net>
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
Previous: Dirk Gouders
Message 5 of 5 in “doc/gitcli: minor fixes”
  1. 1/1 doc/gitcli: minor fixesDirk Gouders, Nov 14, 2026
  2. Junio C HamanoNov 14, 2026
  3. Dirk GoudersNov 14, 2026
  4. doc/gitcli: minor fixesDirk Gouders, Nov 14, 2026
  5. doc/gitcli: minor fixesDirk Gouders, Nov 15, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.