From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>
Subject: [PATCH v2] doc: interpret-trailers: fix cmd examples
Date: Sat, 3 Oct 2026 18:03:19 +0200 [thread overview]
Message-ID: <V2_doc_trailers_cmd_examples.d49@m5gid.xyz> (raw)
In-Reply-To: <doc_trailers_cmd_examples.ce1@m5gid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
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.)
Steal how the `see` example is phrased and use that as a template:
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 <code@khaugsbakk.name>
---
Notes (series):
Topic name (applied): kh/doc-trailers-cmd-examples
v2:
• *Steal* the *existing* example:
https://lore.kernel.org/git/xmqqh5j9mdpx.fsf@gitster.g/
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
Interdiff against v1:
Range-diff against v1:
1: c916709d7a3 ! 1: a8c56a91163 doc: interpret-trailers: fix cmd examples
@@ Commit message
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:
+ Steal how the `see` example is phrased and use that as a template:
Configure a `see` trailer with a command to show the subject of a
commit that is related, and show how it works:
base-commit: e9019fcafe0040228b8631c30f97ae1adb61bcdc
--
2.55.0.793.gc667de3f2c5
next prev parent reply other threads:[~2026-10-03 16:04 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-27 14:12 [PATCH] doc: interpret-trailers: fix cmd examples kristofferhaugsbakk
2026-09-28 18:29 ` Junio C Hamano
2026-09-29 19:10 ` Kristoffer Haugsbakk
2026-10-03 16:03 ` kristofferhaugsbakk [this message]
2026-10-04 16:10 ` [PATCH v2] " Junio C Hamano
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=V2_doc_trailers_cmd_examples.d49@m5gid.xyz \
--to=kristofferhaugsbakk@fastmail.com \
--cc=code@khaugsbakk.name \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.