Re: [PATCH 08/11] doc: trailer.<token>.command: refer to existing example
- From
Junio C Hamano <gitster@pobox.com>
- Date
- May 8, 2023, 19:47 UTC
- Message-ID
- <xmqqwn1imwqk.fsf@gitster.g>
- In-Reply-To
- <5980432179352054955e602cf97b57e97694a28c.1683566870.git.gitgitgadget@gmail.com>
"Linus Arver via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 6 quoted lines
> From: Linus Arver <linusa@google.com> > > Signed-off-by: Linus Arver <linusa@google.com> > --- > Documentation/git-interpret-trailers.txt | 9 +++++---- > 1 file changed, 5 insertions(+), 4 deletions(-)
This patch has more annoying "just rewrapping the text in a strange way without changing anything" than the real change which is to enclose <value> inside the angle brackets (which is good) and adding a new sentence.
We are discouraging the use of .command and recommending folks to use .cmd instead, by the way. At some point we may drop the example, and adding a reference to the example would mean somebody needs to remember removing this when it happens.
Show 20 quoted lines
> diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt > index ac448fd732e..5ca758e363f 100644 > --- a/Documentation/git-interpret-trailers.txt > +++ b/Documentation/git-interpret-trailers.txt > @@ -234,10 +234,11 @@ trailer.<token>.ifmissing:: > that option for trailers with the specified <token>. > > trailer.<token>.command:: > - This option behaves in the same way as 'trailer.<token>.cmd', except > - that it doesn't pass anything as argument to the specified command. > - Instead the first occurrence of substring $ARG is replaced by the > - value that would be passed as argument. > + This option behaves in the > + same way as 'trailer.<token>.cmd', except that it doesn't pass anything as > + argument to the specified command. Instead the first occurrence of substring > + $ARG is replaced by the <value> from the trailer. See the > + 'trailer.see.command' trailer example in the "EXAMPLES" section below. > + > The 'trailer.<token>.command' option has been deprecated in favor of > 'trailer.<token>.cmd' due to the fact that $ARG in the user's command is