Re: [PATCH] Documentation: fix --color option formatting
- From
brian m. carlson <sandals@crustytoothpaste.net>
- Date
- Jul 20, 2018, 22:36 UTC
- Message-ID
- <20180720223608.GE18502@genre.crustytoothpaste.net>
- In-Reply-To
- <20180718174944.GB3084@sigill.intra.peff.net>
On Wed, Jul 18, 2018 at 01:49:44PM -0400, Jeff King wrote:
Show 23 quoted lines
> On Wed, Jul 18, 2018 at 07:37:48PM +0200, Andrei Rybak wrote: > > 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.
Both AsciiDoc 8.6.10 and Asciidoctor support SOURCE_DATE_EPOCH for reproducible builds[0], which should reduce the date noise. We could also add a Makefile knob to set git_version to an empty string or an --abbrev=0 equivalent for such a situation.
[0] https://reproducible-builds.org/specs/source-date-epoch/
-- brian m. carlson: Houston, Texas, US OpenPGP: https://keybase.io/bk2204