[PATCH v3 9/9] doc: notes: use stuck form throughout

From: kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
Date: May 27, 2025, 21:19 UTC
Message-ID: <7751330daa4fe28f4c989e9d27e9701bb21bc0f2.1748380390.git.code@khaugsbakk.name>
In-Reply-To: <cover.1748380390.git.code@khaugsbakk.name>

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

gitcli(7) recommends the *stuck form*. `--ref` is the only one which does not use it.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---

Notes (series):
    v2:
    • New
    • I didn’t spot this in the first round.  Hopefully it’s fine to include
      it as well while we are editing this file.  I would consider making a
      separate thread if I wasn’t editing nearby hunks.

 Documentation/git-notes.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-notes.adoc b/Documentation/git-notes.adoc
index 397f6caa92a..46a232ca718 100644
--- a/Documentation/git-notes.adoc
+++ b/Documentation/git-notes.adoc
@@ -200,7 +200,7 @@ order of similar options. For example, for `-C <object> -m<message>`,
 previous `-C`. This is a known limitation that may be fixed in the
 future.
 
-`--ref <ref>`::
+`--ref=<ref>`::
 	Manipulate the notes tree in _<ref>_.  This overrides
 	`GIT_NOTES_REF` and the `core.notesRef` configuration.  The ref
 	specifies the full refname when it begins with `refs/notes/`; when it

-- 
2.49.0.780.g892193c3f50