| Message ID | b13bd73d24885d65440e22202183bbec9deec1c5.1686017304.git.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Commit | e45e009f5df4f065984f04bb8fc9f80570d222d7 |
| Headers | show |
| Series | docs: interpret-trailers: reword and add examples | expand |
On Tue, Jun 6, 2023 at 4:08 AM Linus Arver via GitGitGadget <gitgitgadget@gmail.com> wrote: > > 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 | 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."
Christian Couder <christian.couder@gmail.com> writes: >> 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." Updated in v4 with a slightly different wording versus your example.
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'. 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