[PATCH v4 8/9] doc: trailer: mention 'key' in DESCRIPTION
- From
- Linus Arver via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Jun 15, 2023, 02:53 UTC
- Message-ID
- <604265c54dff9b2f16b8bf3b1964cae6280b756c.1686797630.git.gitgitgadget@gmail.com>
- In-Reply-To
- <pull.1506.v4.git.git.1686797630.gitgitgadget@gmail.com>
From: Linus Arver <linusa@google.com>
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 <linusa@google.com> --- Documentation/git-interpret-trailers.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 6016af5c203..7e77cbb1cad 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -49,7 +49,10 @@ 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). For convenience, the <token> can be a +shortened string key (e.g., "sign") instead of the full string which should +appear before the separator on the output (e.g., "Signed-off-by"). This can be +configured using the 'trailer.<token>.key' configuration variable. By default the new trailer will appear at the end of all the existing trailers. If there is no existing trailer, the new trailer will appear
-- gitgitgadget