Re: [PATCH 1/6] doc: typeset short command-line options as literal

From: Jeff King <peff@peff.net>
Date: Jun 27, 2016, 18:57 UTC
Message-ID: <20160627185715.GB9594@sigill.intra.peff.net>
In-Reply-To: <20160627174623.11084-1-Matthieu.Moy@imag.fr>

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

Show 8 quoted lines

> It was common in our documentation to surround short option names with
> forward quotes, which renders as italic in HTML. Instead, use backquotes
> which renders as monospace. This is one more step toward conformance to
> Documentation/CodingGuidelines.
> 
> This was obtained with:
> 
>   perl -pi -e "s/'(-[a-z])'/\`\$1\`/g" *.txt

I think this is an improvement, assuming everyone is happy with the new MAN_BOLD_LITERAL default.

I skimmed the diff and it looks there were no mis-conversions (I recommend diff-highlight for this, as it makes it much easier to spot, though perhaps --color-words would help, too).

Show 10 quoted lines

> diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt
> index e453132..cbae886 100644
> --- a/Documentation/git-mv.txt
> +++ b/Documentation/git-mv.txt
> @@ -35,7 +35,7 @@ OPTIONS
>          Skip move or rename actions which would lead to an error
>  	condition. An error happens when a source is neither existing nor
>  	controlled by Git, or when it would overwrite an existing
> -        file unless '-f' is given.
> +        file unless `-f` is given.

git-am complains about the space indentation in the post-image. I know it was there before your patch, but the indentation for that paragraph is off. I wonder if it makes sense to fix it as a preliminary patch.

-Peff