format_commit_message: honor `color=auto` for `%C(auto)`
PATCH 1/1 format_commit_message: honor `color=auto` for `%C(auto)`
git-log(1) documents that when specifying the %C(auto) format placeholder will "turn on auto coloring on the next %placeholders until the color is switched again."
However, when %C(auto) is used, the present implementation will turn colors on unconditionally (even if the color configuration is turned off for the current context - for example, --no-color was specified or the color is auto and the output is not a tty).
Update format_commit_one to examine the current context when a format string of %C(auto) is specified, which ensures that we will not unconditionally write colors. This brings that behavior in line with the behavior of %C(auto,<colorname>), and allows the user the ability to specify that color should be displayed only when the output is a tty.
Additionally, add a test for %C(auto) and update the existing tests for %C(auto,...) as they were misidentified as being applicable to %C(auto).
Tests from Jeff King.
--- pretty.c | 2 +- t/t6006-rev-list-format.sh | 26 +++++++++++++++++++------- 2 files changed, 20 insertions(+), 8 deletions(-)
pretty.c +1 -1
@@ -1063,7 +1063,7 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */switch (placeholder[0 ]) {case 'C' :if (starts_with (placeholder +1 ,"(auto)" )) { - c->auto_color =1 ; + c->auto_color =want_color (c->pretty_ctx->color);return 7 ;/* consumed 7 bytes, "C(auto)" */ }else {int ret =parse_color (sb, placeholder, c);
t/t6006-rev-list-format.sh +19 -7
@@ -184,38 +184,38 @@ commit $head1 [1;31;43mfoo[m EOF -test_expect_success '%C(auto) does not enable color by default' ' +test_expect_success '%C(auto,...) does not enable color by default' ' git log --format=$AUTO_COLOR -1 >actual && has_no_color actual ' -test_expect_success '%C(auto) enables colors for color.diff' ' +test_expect_success '%C(auto,...) enables colors for color.diff' ' git -c color.diff=always log --format=$AUTO_COLOR -1 >actual && has_color actual ' -test_expect_success '%C(auto) enables colors for color.ui' ' +test_expect_success '%C(auto,...) enables colors for color.ui' ' git -c color.ui=always log --format=$AUTO_COLOR -1 >actual && has_color actual ' -test_expect_success '%C(auto) respects --color' ' +test_expect_success '%C(auto,...) respects --color' ' git log --format=$AUTO_COLOR -1 --color >actual && has_color actual ' -test_expect_success '%C(auto) respects --no-color' ' +test_expect_success '%C(auto,...) respects --no-color' ' git -c color.ui=always log --format=$AUTO_COLOR -1 --no-color >actual && has_no_color actual ' -test_expect_success TTY '%C(auto) respects --color=auto (stdout is tty)' ' +test_expect_success TTY '%C(auto,...) respects --color=auto (stdout is tty)' ' test_terminal env TERM=vt100 \ git log --format=$AUTO_COLOR -1 --color=auto >actual && has_color actual ' -test_expect_success '%C(auto) respects --color=auto (stdout not tty)' ' +test_expect_success '%C(auto,...) respects --color=auto (stdout not tty)' ' ( TERM=vt100 && export TERM && git log --format=$AUTO_COLOR -1 --color=auto >actual &&
@@ -223,6 +223,18 @@ test_expect_success '%C(auto) respects --color=auto (stdout not tty)' ' ) ' +test_expect_success '%C(auto) respects --color' ' + git log --color --format="%C(auto)%H" -1 >actual && + printf "\\033[33m%s\\033[m\\n" $(git rev-parse HEAD) >expect && + test_cmp expect actual +' + +test_expect_success '%C(auto) respects --no-color' ' + git log --no-color --format="%C(auto)%H" -1 >actual && + git rev-parse HEAD >expect && + test_cmp expect actual +' + iconv -f utf-8 -t $test_encoding > commit-msg <<EOF Test printing of complex bodies
Signature · 1 line
2.7.4 (Apple Git-66)
Quoted 16 lines · Edward Thomson
git-log(1) documents that when specifying the
%C(auto)format placeholder will "turn on auto coloring on the next %placeholders until the color is switched again."However, when
%C(auto)is used, the present implementation will turn colors on unconditionally (even if the color configuration is turned off for the current context - for example,--no-colorwas specified or the color isautoand the output is not a tty).Update
format_commit_oneto examine the current context when a format string of%C(auto)is specified, which ensures that we will not unconditionally write colors. This brings that behavior in line with the behavior of%C(auto,<colorname>), and allows the user the ability to specify that color should be displayed only when the output is a tty.
Quoted 3 lines
Additionally, add a test for
%C(auto)and update the existing tests for%C(auto,...)as they were misidentified as being applicable to%C(auto).
Explanation and the patch look good.
Quoted 5 lines
Signed-off-by Edward Thomson <[email protected]>Tests from Jeff King.
Signed-off-by Jeff King <[email protected]>
Trailers should all go at the bottom in a single stanza, and should generally be in chronological order (so you got the bits from with an s-o-b, and then you signed off the whole thing). IOW:
Quoted 4 lines
Tests from Jeff King.
Signed-off-by Jeff King <[email protected]>Signed-off-by Edward Thomson <[email protected]>
I suspect Junio can just tweak that while applying, unless there's another reason to re-roll.
(Also for anybody watching, Ed did not just make up my signoff; I gave it to him off-list).
-Peff
Quoted 5 lines · Jeff King
I suspect Junio can just tweak that while applying, unless there's another reason to re-roll.
(Also for anybody watching, Ed did not just make up my signoff; I gave it to him off-list).
Understood. Thanks.