Re: [PATCH 2/6] doc: typeset long command-line options as literal

From: Jeff King <peff@peff.net>
Date: Jun 27, 2016, 19:04 UTC
Message-ID: <20160627190422.GC9594@sigill.intra.peff.net>
In-Reply-To: <20160627174623.11084-2-Matthieu.Moy@imag.fr>

On Mon, Jun 27, 2016 at 07:46:19PM +0200, Matthieu Moy wrote:

Show 9 quoted lines

> Similarly to the previous commit, use backquotes instead of
> forward-quotes, for long options.
> 
> This was obtained with:
> 
>   perl -pi -e "s/'(--[a-z][a-z=<>-]*)'/\`\$1\`/g" *.txt
> 
> and manual tweak to remove false positive in ascii-art (o'--o'--o' to
> describe rewritten history).

These mostly looked good, but:

Show 5 quoted lines

>  grep.extendedRegexp::
> -	If set to true, enable '--extended-regexp' option by default. This
> -	option is ignored when the `grep.patternType` option is set to a value
> +	If set to true, enable `--extended-regexp` option by default. This
> +	option is ignored when the 'grep.patternType' option is set to a value

What's going on in the second line here? We remove the backticks from grep.patternType (which is not even a thing that should be touched by your pattern).

Show 6 quoted lines

> @@ -1916,7 +1916,7 @@ log.decorate::
>  	command. If 'short' is specified, the ref name prefixes 'refs/heads/',
>  	'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
>  	specified, the full ref name (including prefix) will be printed.
> -	This is the same as the log commands '--decorate' option.
> +	This is the same as the log commands `--decorate` option.

This one conflicts applying on top of master, but the resolution is fairly straightforward.

-Peff