{"thread":{"id":"66401","subject":"[PATCH] doc: interpret-trailers: fix cmd examples","startedAt":"2026-09-27T14:12:43Z","lastAt":"2026-10-04T16:10:16Z","messageCount":5,"participants":["kristofferhaugsbakk@fastmail.com","Junio C Hamano","Kristoffer Haugsbakk"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"553385","messageId":"doc_trailers_cmd_examples.ce1@m5gid.xyz","threadId":"66401","inReplyTo":null,"subject":"[PATCH] doc: interpret-trailers: fix cmd examples","fromName":"","fromEmail":"kristofferhaugsbakk@fastmail.com","sentAt":"2026-09-27T14:12:27Z","receivedAt":"2026-09-27T14:12:43Z","isPatch":true,"body":"From: Kristoffer Haugsbakk <code@khaugsbakk.name>\n\nFix `trailer.<key-alias>.cmd` examples which have remained unchanged\nsince they were written in c364b7ef (trailer: add new .cmd config\noption, 2021-05-03). (Modulo formatting changes.)\n\nUse this example as a guide for how to phrase it:\n\n    Configure a `see` trailer with a command to show the subject of a\n    commit that is related, and show how it works:\n\nSigned-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>\n---\n\nNotes (series):\n    Topic name: kh/doc-trailers-cmd-examples\n\n Documentation/git-interpret-trailers.adoc | 10 ++++------\n 1 file changed, 4 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/git-interpret-trailers.adoc b/Documentation/git-interpret-trailers.adoc\nindex 77b4f63b05c..3e81632b252 100644\n--- a/Documentation/git-interpret-trailers.adoc\n+++ b/Documentation/git-interpret-trailers.adoc\n@@ -305,9 +305,8 @@ subject\n Fix #42\n ------------\n \n-* Configure a `help` trailer with a cmd use a script `glog-find-author`\n-  which search specified author identity from git log in git repository\n-  and show how it works:\n+* Configure a `help` trailer with a command that searches for an author\n+  identity and show how it works:\n +\n ------------\n $ cat ~/bin/glog-find-author\n@@ -329,9 +328,8 @@ Helped-by: Junio C Hamano <gitster@pobox.com>\n Helped-by: Christian Couder <christian.couder@gmail.com>\n ------------\n \n-* Configure a `ref` trailer with a cmd use a script `glog-grep`\n-  to grep last relevant commit from git log in the git repository\n-  and show how it works:\n+* Configure a `ref` trailer with a command that searches for the last\n+  relevant commit and show how it works:\n +\n ------------\n $ cat ~/bin/glog-grep\n\nbase-commit: e9019fcafe0040228b8631c30f97ae1adb61bcdc\n-- \n2.55.0.793.gc667de3f2c5\n\n"},{"id":"553509","messageId":"xmqqh5j9mdpx.fsf@gitster.g","threadId":"66401","inReplyTo":"doc_trailers_cmd_examples.ce1@m5gid.xyz","subject":"Re: [PATCH] doc: interpret-trailers: fix cmd examples","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2026-09-28T18:29:30Z","receivedAt":"2026-09-28T18:29:33Z","isPatch":true,"body":"kristofferhaugsbakk@fastmail.com writes:\n\n> From: Kristoffer Haugsbakk <code@khaugsbakk.name>\n>\n> Fix `trailer.<key-alias>.cmd` examples which have remained unchanged\n> since they were written in c364b7ef (trailer: add new .cmd config\n> option, 2021-05-03). (Modulo formatting changes.)\n>\n> Use this example as a guide for how to phrase it:\n>\n>     Configure a `see` trailer with a command to show the subject of a\n>     commit that is related, and show how it works:\n\nThis read as if you are declaring that you use a template that\ninvented to consistently give intro for each example, and made it\nlook like the use of `see` was as a placeholder.  It would have\navoided the \"Huh?\" reaction if it were phrased like so:\n\n    Steal how example to show the `see` trailer is phrased and use\n    it throughout:\n\n\tConfigure a `see` trailer ...\n\nOther than that, this looks good.\n\n> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>\n> ---\n>\n> Notes (series):\n>     Topic name: kh/doc-trailers-cmd-examples\n>\n>  Documentation/git-interpret-trailers.adoc | 10 ++++------\n>  1 file changed, 4 insertions(+), 6 deletions(-)\n>\n> diff --git a/Documentation/git-interpret-trailers.adoc b/Documentation/git-interpret-trailers.adoc\n> index 77b4f63b05c..3e81632b252 100644\n> --- a/Documentation/git-interpret-trailers.adoc\n> +++ b/Documentation/git-interpret-trailers.adoc\n> @@ -305,9 +305,8 @@ subject\n>  Fix #42\n>  ------------\n>  \n> -* Configure a `help` trailer with a cmd use a script `glog-find-author`\n> -  which search specified author identity from git log in git repository\n> -  and show how it works:\n> +* Configure a `help` trailer with a command that searches for an author\n> +  identity and show how it works:\n>  +\n>  ------------\n>  $ cat ~/bin/glog-find-author\n> @@ -329,9 +328,8 @@ Helped-by: Junio C Hamano <gitster@pobox.com>\n>  Helped-by: Christian Couder <christian.couder@gmail.com>\n>  ------------\n>  \n> -* Configure a `ref` trailer with a cmd use a script `glog-grep`\n> -  to grep last relevant commit from git log in the git repository\n> -  and show how it works:\n> +* Configure a `ref` trailer with a command that searches for the last\n> +  relevant commit and show how it works:\n>  +\n>  ------------\n>  $ cat ~/bin/glog-grep\n>\n> base-commit: e9019fcafe0040228b8631c30f97ae1adb61bcdc\n"},{"id":"553631","messageId":"be487f47-054c-443f-b5cb-b612269fedba@app.fastmail.com","threadId":"66401","inReplyTo":"xmqqh5j9mdpx.fsf@gitster.g","subject":"Re: [PATCH] doc: interpret-trailers: fix cmd examples","fromName":"Kristoffer Haugsbakk","fromEmail":"kristofferhaugsbakk@fastmail.com","sentAt":"2026-09-29T19:10:48Z","receivedAt":"2026-09-29T19:11:12Z","isPatch":true,"body":"On Mon, Sep 28, 2026, at 20:29, Junio C Hamano wrote:\n> kristofferhaugsbakk@fastmail.com writes:\n>\n>> From: Kristoffer Haugsbakk <code@khaugsbakk.name>\n>>\n>> Fix `trailer.<key-alias>.cmd` examples which have remained unchanged\n>> since they were written in c364b7ef (trailer: add new .cmd config\n>> option, 2021-05-03). (Modulo formatting changes.)\n>>\n>> Use this example as a guide for how to phrase it:\n>>\n>>     Configure a `see` trailer with a command to show the subject of a\n>>     commit that is related, and show how it works:\n>\n> This read as if you are declaring that you use a template that\n> invented to consistently give intro for each example, and made it\n> look like the use of `see` was as a placeholder.  It would have\n> avoided the \"Huh?\" reaction if it were phrased like so:\n>\n>     Steal how example to show the `see` trailer is phrased and use\n>     it throughout:\n>\n> \tConfigure a `see` trailer ...\n>\n> Other than that, this looks good.\n\nI’ll make that change.\n"},{"id":"554069","messageId":"V2_doc_trailers_cmd_examples.d49@m5gid.xyz","threadId":"66401","inReplyTo":"doc_trailers_cmd_examples.ce1@m5gid.xyz","subject":"[PATCH v2] doc: interpret-trailers: fix cmd examples","fromName":"","fromEmail":"kristofferhaugsbakk@fastmail.com","sentAt":"2026-10-03T16:03:19Z","receivedAt":"2026-10-03T16:04:18Z","isPatch":true,"body":"From: Kristoffer Haugsbakk <code@khaugsbakk.name>\n\nFix `trailer.<key-alias>.cmd` examples which have remained unchanged\nsince they were written in c364b7ef (trailer: add new .cmd config\noption, 2021-05-03). (Modulo formatting changes.)\n\nSteal how the `see` example is phrased and use that as a template:\n\n    Configure a `see` trailer with a command to show the subject of a\n    commit that is related, and show how it works:\n\nSigned-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>\n---\n\nNotes (series):\n    Topic name (applied): kh/doc-trailers-cmd-examples\n    \n    v2:\n    • *Steal* the *existing* example:\n       https://lore.kernel.org/git/xmqqh5j9mdpx.fsf@gitster.g/\n\n Documentation/git-interpret-trailers.adoc | 10 ++++------\n 1 file changed, 4 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/git-interpret-trailers.adoc b/Documentation/git-interpret-trailers.adoc\nindex 77b4f63b05c..3e81632b252 100644\n--- a/Documentation/git-interpret-trailers.adoc\n+++ b/Documentation/git-interpret-trailers.adoc\n@@ -305,9 +305,8 @@ subject\n Fix #42\n ------------\n \n-* Configure a `help` trailer with a cmd use a script `glog-find-author`\n-  which search specified author identity from git log in git repository\n-  and show how it works:\n+* Configure a `help` trailer with a command that searches for an author\n+  identity and show how it works:\n +\n ------------\n $ cat ~/bin/glog-find-author\n@@ -329,9 +328,8 @@ Helped-by: Junio C Hamano <gitster@pobox.com>\n Helped-by: Christian Couder <christian.couder@gmail.com>\n ------------\n \n-* Configure a `ref` trailer with a cmd use a script `glog-grep`\n-  to grep last relevant commit from git log in the git repository\n-  and show how it works:\n+* Configure a `ref` trailer with a command that searches for the last\n+  relevant commit and show how it works:\n +\n ------------\n $ cat ~/bin/glog-grep\n\nInterdiff against v1:\n\nRange-diff against v1:\n1:  c916709d7a3 ! 1:  a8c56a91163 doc: interpret-trailers: fix cmd examples\n    @@ Commit message\n         since they were written in c364b7ef (trailer: add new .cmd config\n         option, 2021-05-03). (Modulo formatting changes.)\n     \n    -    Use this example as a guide for how to phrase it:\n    +    Steal how the `see` example is phrased and use that as a template:\n     \n             Configure a `see` trailer with a command to show the subject of a\n             commit that is related, and show how it works:\n\nbase-commit: e9019fcafe0040228b8631c30f97ae1adb61bcdc\n-- \n2.55.0.793.gc667de3f2c5\n\n"},{"id":"554116","messageId":"xmqq1pa5v44a.fsf@gitster.g","threadId":"66401","inReplyTo":"V2_doc_trailers_cmd_examples.d49@m5gid.xyz","subject":"Re: [PATCH v2] doc: interpret-trailers: fix cmd examples","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2026-10-04T16:10:13Z","receivedAt":"2026-10-04T16:10:16Z","isPatch":true,"body":"kristofferhaugsbakk@fastmail.com writes:\n\n> From: Kristoffer Haugsbakk <code@khaugsbakk.name>\n>\n> Fix `trailer.<key-alias>.cmd` examples which have remained unchanged\n> since they were written in c364b7ef (trailer: add new .cmd config\n> option, 2021-05-03). (Modulo formatting changes.)\n>\n> Steal how the `see` example is phrased and use that as a template:\n>\n>     Configure a `see` trailer with a command to show the subject of a\n>     commit that is related, and show how it works:\n>\n> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>\n> ---\n\nLet me mark the topic for 'next'.\nThanks.\n\n"}]}