Re: [PATCH] builtin/config.c: don't print a newline with --color
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Mar 7, 2019, 00:50 UTC
- Message-ID
- <xmqqbm2no6by.fsf@gitster-ct.c.googlers.com>
- In-Reply-To
- <20190305042050.GE19800@sigill.intra.peff.net>
Jeff King <peff@peff.net> writes:
> Mostly I was just surprised by the new behavior. Perhaps the right > solution is not a patch to the code, but to the documentation. Something > like:
Let me forge your sign-off and commit this to prevent us from forgetting.
Thanks, all.
-- >8 -- From: Jeff King <peff@peff.net> Date: Mon, 4 Mar 2019 23:20:51 -0500 Subject: [PATCH] config: document --type=color output is a complete line
Even though the newer "--type=color" option to "git config" is meant to be upward compatible with the traditional "--get-color" option, unlike the latter, its output is not an incomplete line that lack the LF at the end. That makes it consistent with output of other types like "git config --type=bool".
Document it, as it sometimes surprises unsuspecting users.
Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com> --- Documentation/git-config.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index 1bfe9f56a7..611a32445c 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -240,7 +240,9 @@ Valid `<type>`'s include: output. The optional `default` parameter is used instead, if there is no color configured for `name`. + -`--type=color [--default=<default>]` is preferred over `--get-color`. +`--type=color [--default=<default>]` is preferred over `--get-color` +(but note that `--get-color` will omit the trailing newline printed by +--type=color). -e:: --edit::
-- 2.21.0-4-g36eb1cb9cf