{"thread":{"id":"48909","subject":"[PATCH] Documentation: fix --color option formatting","startedAt":"2018-07-18T17:37:54Z","lastAt":"2018-07-20T23:37:28Z","messageCount":5,"participants":["Andrei Rybak","Jeff King","Junio C Hamano","brian m. carlson"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"352926","messageId":"ccf73807-1856-1ce8-365a-0c4fb25ea7bf@gmail.com","threadId":"48909","inReplyTo":null,"subject":"[PATCH] Documentation: fix --color option formatting","fromName":"Andrei Rybak","fromEmail":"rybak.a.v@gmail.com","sentAt":"2018-07-18T17:37:48Z","receivedAt":"2018-07-18T17:37:54Z","isPatch":true,"sender":{"key":"rybak.a.v@gmail.com","avatar":"https://avatars.githubusercontent.com/u/624072?v=4"},"body":"Add missing colon in two places to fix formatting of options.\n\nSigned-off-by: Andrei Rybak \n---\n\nDone on top of maint.\n\nThe earliest this patch applies is on top of commit aebd23506e (\"Merge\nbranch 'jk/ui-color-always-to-auto-maint' into\njk/ui-color-always-to-auto\", 2017-10-04), one commit away from the\ncommit that added both of the affected lines: 0c88bf5050 (provide\n--color option for all ref-filter users, 2017-10-03).\n\nI grepped the Documentation folder, and haven't found any other\nsimilar typos.\n\n---\n\n Documentation/git-for-each-ref.txt | 2 +-\n Documentation/git-tag.txt | 2 +-\n 2 files changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt\nindex 085d177d97..901faef1bf 100644\n--- a/Documentation/git-for-each-ref.txt\n+++ b/Documentation/git-for-each-ref.txt\n@@ -57,7 +57,7 @@ OPTIONS\n \t`xx`; for example `%00` interpolates to `\\0` (NUL),\n \t`%09` to `\\t` (TAB) and `%0a` to `\\n` (LF).\n \n---color[=]:\n+--color[=]::\n \tRespect any colors specified in the `--format` option. The\n \t`` field must be one of `always`, `never`, or `auto` (if\n \t`` is absent, behave as if `always` was given).\ndiff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt\nindex 87c4288ffc..92f9c12b87 100644\n--- a/Documentation/git-tag.txt\n+++ b/Documentation/git-tag.txt\n@@ -115,7 +115,7 @@ options for details.\n \tvariable if it exists, or lexicographic order otherwise. See\n \tlinkgit:git-config[1].\n \n---color[=]:\n+--color[=]::\n \tRespect any colors specified in the `--format` option. The\n \t`` field must be one of `always`, `never`, or `auto` (if\n \t`` is absent, behave as if `always` was given).\n-- \n2.18.0\n"},{"id":"352932","messageId":"20180718174944.GB3084@sigill.intra.peff.net","threadId":"48909","inReplyTo":"ccf73807-1856-1ce8-365a-0c4fb25ea7bf@gmail.com","subject":"Re: [PATCH] Documentation: fix --color option formatting","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2018-07-18T17:49:44Z","receivedAt":"2018-07-18T17:49:47Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Wed, Jul 18, 2018 at 07:37:48PM +0200, Andrei Rybak wrote:\n\n> Add missing colon in two places to fix formatting of options.\n\nThanks for catching.\n\n> diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt\n> index 085d177d97..901faef1bf 100644\n> --- a/Documentation/git-for-each-ref.txt\n> +++ b/Documentation/git-for-each-ref.txt\n> @@ -57,7 +57,7 @@ OPTIONS\n> \t`xx`; for example `%00` interpolates to `\\0` (NUL),\n> \t`%09` to `\\t` (TAB) and `%0a` to `\\n` (LF).\n> \n> ---color[=]:\n> +--color[=]::\n> \tRespect any colors specified in the `--format` option. The\n> \t`` field must be one of `always`, `never`, or `auto` (if\n> \t`` is absent, behave as if `always` was given).\n\nThis is obviously the right fix.\n\nI am guilty of not always building the documentation and eye-balling the\noutput when I'm not specifically changing the formatting. I wonder if we\ncould provide tooling to make that easier, by showing a diff between the\ntext-formatted manpages before and after a series. I've manually hacked\nstuff up like that in the past, but there's often a lot of noise around\ndate and version info in the footers.\n\n-Peff\n"},{"id":"352940","messageId":"xmqqh8kwjtaq.fsf@gitster-ct.c.googlers.com","threadId":"48909","inReplyTo":"ccf73807-1856-1ce8-365a-0c4fb25ea7bf@gmail.com","subject":"Re: [PATCH] Documentation: fix --color option formatting","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2018-07-18T18:24:45Z","receivedAt":"2018-07-18T18:24:51Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Andrei Rybak writes:\n\n> Add missing colon in two places to fix formatting of options.\n>\n> Signed-off-by: Andrei Rybak \n> ---\n>\n> Done on top of maint.\n>\n> The earliest this patch applies is on top of commit aebd23506e (\"Merge\n> branch 'jk/ui-color-always-to-auto-maint' into\n> jk/ui-color-always-to-auto\", 2017-10-04), one commit away from the\n> commit that added both of the affected lines: 0c88bf5050 (provide\n> --color option for all ref-filter users, 2017-10-03).\n>\n> I grepped the Documentation folder, and haven't found any other\n> similar typos.\n\nThanks.\n"},{"id":"353204","messageId":"20180720223608.GE18502@genre.crustytoothpaste.net","threadId":"48909","inReplyTo":"20180718174944.GB3084@sigill.intra.peff.net","subject":"Re: [PATCH] Documentation: fix --color option formatting","fromName":"brian m. carlson","fromEmail":"sandals@crustytoothpaste.net","sentAt":"2018-07-20T22:36:08Z","receivedAt":"2018-07-20T22:36:17Z","isPatch":true,"sender":{"key":"sandals@crustytoothpaste.net","avatar":"https://avatars.githubusercontent.com/u/497054?v=4"},"body":"On Wed, Jul 18, 2018 at 01:49:44PM -0400, Jeff King wrote:\n> On Wed, Jul 18, 2018 at 07:37:48PM +0200, Andrei Rybak wrote:\n> > diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt\n> > index 085d177d97..901faef1bf 100644\n> > --- a/Documentation/git-for-each-ref.txt\n> > +++ b/Documentation/git-for-each-ref.txt\n> > @@ -57,7 +57,7 @@ OPTIONS\n> > \t`xx`; for example `%00` interpolates to `\\0` (NUL),\n> > \t`%09` to `\\t` (TAB) and `%0a` to `\\n` (LF).\n> > \n> > ---color[=]:\n> > +--color[=]::\n> > \tRespect any colors specified in the `--format` option. The\n> > \t`` field must be one of `always`, `never`, or `auto` (if\n> > \t`` is absent, behave as if `always` was given).\n> \n> This is obviously the right fix.\n> \n> I am guilty of not always building the documentation and eye-balling the\n> output when I'm not specifically changing the formatting. I wonder if we\n> could provide tooling to make that easier, by showing a diff between the\n> text-formatted manpages before and after a series. I've manually hacked\n> stuff up like that in the past, but there's often a lot of noise around\n> date and version info in the footers.\n\nBoth AsciiDoc 8.6.10 and Asciidoctor support SOURCE_DATE_EPOCH for\nreproducible builds[0], which should reduce the date noise. We could\nalso add a Makefile knob to set git_version to an empty string or an\n--abbrev=0 equivalent for such a situation.\n\n[0] https://reproducible-builds.org/specs/source-date-epoch/\n-- \nbrian m. carlson: Houston, Texas, US\nOpenPGP: https://keybase.io/bk2204\n"},{"id":"353207","messageId":"xmqqo9f18onf.fsf@gitster-ct.c.googlers.com","threadId":"48909","inReplyTo":"20180720223608.GE18502@genre.crustytoothpaste.net","subject":"Re: [PATCH] Documentation: fix --color option formatting","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2018-07-20T23:37:24Z","receivedAt":"2018-07-20T23:37:28Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"brian m. carlson\" writes:\n\n> Both AsciiDoc 8.6.10 and Asciidoctor support SOURCE_DATE_EPOCH for\n> reproducible builds[0], which should reduce the date noise. We could\n> also add a Makefile knob to set git_version to an empty string or an\n> --abbrev=0 equivalent for such a situation.\n>\n> [0] https://reproducible-builds.org/specs/source-date-epoch/\n\nI probably should take advantage of this feature and update the\ninstall target of Documentation/Makefile, where I manually filter\nout these noise changes between what is installed and what is going\nto be. That serves as my final sanity check before pushing out the\nresult of an integration cycle that updates the 'master' branch, as\nthat is when the pre-formatted html and man pages are updated, and\nas part of that, \"make install\" for these two formats are run to\ngive me a chance to eyeball the differences.\n\nBeing able to lose the (impricise) manual filtering would be great.\n\n"}]}