From: Jeff King <peff@peff.net>
Date: Wed, 18 Jul 2018 17:49:44 GMT
Subject: Re: [PATCH] Documentation: fix --color option formatting
Message-ID: <20180718174944.GB3084@sigill.intra.peff.net>
In-Reply-To: <ccf73807-1856-1ce8-365a-0c4fb25ea7bf@gmail.com>

On Wed, Jul 18, 2018 at 07:37:48PM +0200, Andrei Rybak wrote:

> Add missing colon in two places to fix formatting of options.

Thanks for catching.

> diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
> index 085d177d97..901faef1bf 100644
> --- a/Documentation/git-for-each-ref.txt
> +++ b/Documentation/git-for-each-ref.txt
> @@ -57,7 +57,7 @@ OPTIONS
>  	`xx`; for example `%00` interpolates to `\0` (NUL),
>  	`%09` to `\t` (TAB) and `%0a` to `\n` (LF).
>  
> ---color[=<when>]:
> +--color[=<when>]::
>  	Respect any colors specified in the `--format` option. The
>  	`<when>` field must be one of `always`, `never`, or `auto` (if
>  	`<when>` is absent, behave as if `always` was given).

This is obviously the right fix.

I am guilty of not always building the documentation and eye-balling the
output when I'm not specifically changing the formatting. I wonder if we
could provide tooling to make that easier, by showing a diff between the
text-formatted manpages before and after a series. I've manually hacked
stuff up like that in the past, but there's often a lot of noise around
date and version info in the footers.

-Peff