From: Jean-Noël Avila <avila.jn@gmail.com>
Date: Thu, 21 Mar 2024 10:28:01 GMT
Subject: Re: [PATCH] doc/gitremote-helpers: fix more missing single-quotes
Message-ID: <519698f1-1daf-4085-9aec-380f44492e72@gmail.com>
In-Reply-To: <20240320091748.GA2444639@coredump.intra.peff.net>

Le 20/03/2024 à 10:17, Jeff King a écrit :
> There are a few cases left in gitremote-helpers.txt that are missing a
> closing quote, so you end up with:
> 
>   'option deepen-since <timestamp>
> 
> with a stray opening quote instead of rendering correctly in italics.
> These should have been part of 51d41dc243 (doc/gitremote-helpers: fix
> missing single-quote, 2024-03-07), but apparently my eyesight is not
> what it once was. Hopefully this is now all of them.
> 
> Signed-off-by: Jeff King <peff@peff.net>
> ---
> This should go on top of jk/doc-remote-helpers-markup-fix.
> 
>  Documentation/gitremote-helpers.txt | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
> index 83e99192e1..cd4e16abad 100644
> --- a/Documentation/gitremote-helpers.txt
> +++ b/Documentation/gitremote-helpers.txt
> @@ -470,14 +470,14 @@ set by Git if the remote helper has the 'option' capability.
>  'option depth' <depth>::
>  	Deepens the history of a shallow repository.
>  
> -'option deepen-since <timestamp>::
> +'option deepen-since' <timestamp>::
>  	Deepens the history of a shallow repository based on time.
>  
> -'option deepen-not <ref>::
> +'option deepen-not' <ref>::
>  	Deepens the history of a shallow repository excluding ref.
>  	Multiple options add up.
>  
> -'option deepen-relative {'true'|'false'}::
> +'option deepen-relative' {'true'|'false'}::
>  	Deepens the history of a shallow repository relative to
>  	current boundary. Only valid when used with "option depth".

The syntax for describing alternatives is specified as (true|false).

Also, in my reworks of syntax, I chose to remove all formatting from the
term parts of the description lists.

Thanks