Re: [PATCH v3 8/9] doc: trailer: mention 'key' in DESCRIPTION
From: Christian Couder <hidden>
Date: 2023-06-14 15:27:51
On Tue, Jun 6, 2023 at 4:08 AM Linus Arver via GitGitGadget [off-list ref] wrote:
quoted hunk ↗ jump to hunk
From: Linus Arver <redacted> The 'key' option is used frequently in the examples at the bottom but there is no mention of it in the description. Signed-off-by: Linus Arver <redacted> --- Documentation/git-interpret-trailers.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index b034784e1d8..2e92640543c 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt@@ -48,7 +48,9 @@ token: value ------------------------------------------------ This means that the trimmed <token> and <value> will be separated by -`': '` (one colon followed by one space). +`': '` (one colon followed by one space). If the <token> should have a different +string representation than itself, then the 'key' can be configured with +'trailer.<token>.key'.
I would rather say something like: "A <token> can be a shortcut name, for example "sign", instead of the full string, for example "Signed-off-by", which should appear before the separator on the output. This can be configured using the 'trailer.<token>.key' configuration variable."