From: Andrei Rybak <hidden> Date: 2018-07-18 17:37:54
Add missing colon in two places to fix formatting of options.
Signed-off-by: Andrei Rybak <redacted>
---
Done on top of maint.
The earliest this patch applies is on top of commit aebd23506e ("Merge
branch 'jk/ui-color-always-to-auto-maint' into
jk/ui-color-always-to-auto", 2017-10-04), one commit away from the
commit that added both of the affected lines: 0c88bf5050 (provide
--color option for all ref-filter users, 2017-10-03).
I grepped the Documentation folder, and haven't found any other
similar typos.
---
Documentation/git-for-each-ref.txt | 2 +-
Documentation/git-tag.txt | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
@@ -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).
@@ -115,7 +115,7 @@ options for details. variable if it exists, or lexicographic order otherwise. See linkgit:git-config[1].---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).
@@ -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
@@ -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