Thread (5 messages) 5 messages, 2 authors, 9d ago

[PATCH] doc: interpret-trailers: fix cmd examples

flat view
COOLING9d

From: <hidden>
Date: 2026-09-27 14:12:43
Subsystem: documentation, the rest · Maintainers: Jonathan Corbet, Linus Torvalds

From: Kristoffer Haugsbakk <redacted>

Fix `trailer.<key-alias>.cmd` examples which have remained unchanged
since they were written in c364b7ef (trailer: add new .cmd config
option, 2021-05-03). (Modulo formatting changes.)

Use this example as a guide for how to phrase it:

    Configure a `see` trailer with a command to show the subject of a
    commit that is related, and show how it works:

Signed-off-by: Kristoffer Haugsbakk <redacted>
---

Notes (series):
    Topic name: kh/doc-trailers-cmd-examples

 Documentation/git-interpret-trailers.adoc | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-interpret-trailers.adoc b/Documentation/git-interpret-trailers.adoc
index 77b4f63b05c..3e81632b252 100644
--- a/Documentation/git-interpret-trailers.adoc
+++ b/Documentation/git-interpret-trailers.adoc
@@ -305,9 +305,8 @@ subject
 Fix #42
 ------------
 
-* Configure a `help` trailer with a cmd use a script `glog-find-author`
-  which search specified author identity from git log in git repository
-  and show how it works:
+* Configure a `help` trailer with a command that searches for an author
+  identity and show how it works:
 +
 ------------
 $ cat ~/bin/glog-find-author
@@ -329,9 +328,8 @@ Helped-by: Junio C Hamano <gitster@pobox.com>
 Helped-by: Christian Couder <christian.couder@gmail.com>
 ------------
 
-* Configure a `ref` trailer with a cmd use a script `glog-grep`
-  to grep last relevant commit from git log in the git repository
-  and show how it works:
+* Configure a `ref` trailer with a command that searches for the last
+  relevant commit and show how it works:
 +
 ------------
 $ cat ~/bin/glog-grep
base-commit: e9019fcafe0040228b8631c30f97ae1adb61bcdc
-- 
2.55.0.793.gc667de3f2c5
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help