Re: [PATCH] Documentation/git-interpret-trailers: explain possible values

From: Junio C Hamano <gitster@pobox.com>
Date: Jul 20, 2018, 22:23 UTC
Message-ID: <xmqq1sbxa6mv.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20180720215349.179542-1-sbeller@google.com>

Stefan Beller <sbeller@google.com> writes:

Show 5 quoted lines

> Signed-off-by: Stefan Beller <sbeller@google.com>
> ---
>
> Maybe we rather want to refer to the options that are described further
> down in the document?

I have no strong preference either way.

The patch looks reasonable to me; Christian?

Show 38 quoted lines

>
>  Documentation/git-interpret-trailers.txt | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
> index 9111c47a1bf..b8fafb1e8bd 100644
> --- a/Documentation/git-interpret-trailers.txt
> +++ b/Documentation/git-interpret-trailers.txt
> @@ -88,7 +88,8 @@ OPTIONS
>  	Specify where all new trailers will be added.  A setting
>  	provided with '--where' overrides all configuration variables
>  	and applies to all '--trailer' options until the next occurrence of
> -	'--where' or '--no-where'.
> +	'--where' or '--no-where'. Possible values are `after`, `before`,
> +	`end` or `start`.
>  
>  --if-exists <action>::
>  --no-if-exists::
> @@ -96,7 +97,8 @@ OPTIONS
>  	least one trailer with the same <token> in the message.  A setting
>  	provided with '--if-exists' overrides all configuration variables
>  	and applies to all '--trailer' options until the next occurrence of
> -	'--if-exists' or '--no-if-exists'.
> +	'--if-exists' or '--no-if-exists'. Possible actions are `addIfDifferent`,
> +	`addIfDifferentNeighbor`, `add`, `replace` and `doNothing`.
>  
>  --if-missing <action>::
>  --no-if-missing::
> @@ -104,7 +106,8 @@ OPTIONS
>  	trailer with the same <token> in the message.  A setting
>  	provided with '--if-missing' overrides all configuration variables
>  	and applies to all '--trailer' options until the next occurrence of
> -	'--if-missing' or '--no-if-missing'.
> +	'--if-missing' or '--no-if-missing'. Possible actions are `doNothing`
> +	or `add`.
>  
>  --only-trailers::
>  	Output only the trailers, not any other parts of the input.