Re: [PATCH v3 13/13] trailer doc: <token> is a <key> or <keyAlias>, not both
- From
- Jonathan Tan <jonathantanmy@google.com>
- Date
- Sep 19, 2023, 22:59 UTC
- Message-ID
- <20230919225926.2189091-1-jonathantanmy@google.com>
- In-Reply-To
- <0b9525db5a0787fdc71834abad9151aa03acc497.1694125210.git.gitgitgadget@gmail.com>
"Linus Arver via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 22 quoted lines
> @@ -248,34 +258,40 @@ With `add`, a new trailer will be added. > + > With `doNothing`, nothing will be done. > > -trailer.<token>.key:: > - This `key` will be used instead of <token> in the trailer. At > - the end of this key, a separator can appear and then some > - space characters. By default the only valid separator is ':', > - but this can be changed using the `trailer.separators` config > - variable. > +trailer.<keyAlias>.key:: > + Defines a <keyAlias> for the <key>. The <keyAlias> must be a > + prefix (case does not matter) of the <key>. For example, in `git > + config trailer.ack.key "Acked-by"` the "Acked-by" is the <key> and > + the "ack" is the <keyAlias>. This configuration allows the shorter > + `--trailer "ack:..."` invocation on the command line using the "ack" > + <keyAlias> instead of the longer `--trailer "Acked-by:..."`. > ++ > +At the end of the <key>, a separator can appear and then some > +space characters. By default the only valid separator is ':', > +but this can be changed using the `trailer.separators` config > +variable.
I think all the other patches will be a great help to the user, but I'm on the fence about this one. Someone who knows these trailer components by their old names might be confused upon seeing tne new ones, so I'm inclined to minimize such changes. I do think that the new names make more sense, though.
The documentation doesn't seem to say what happens when trailer.ack.cmd and trailer.Acked-by.cmd (replace "cmd" with whatever) are defined, but that was true previously too (and knowing this does not really enable the user to be able to do something they previously couldn't, so this is fine).