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.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Edward Thomson <ethomson@edwardthomson.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/pretty.c b/pretty.c
index 92b2870a7eabb6a99ffbbcfc222d2ff1c1186fa0..3908e8f100b4b26ff417890e1aceca54ce5310fd 100644 (file)
--- a/pretty.c
+++ b/pretty.c
@@ -1061,7 +1061,7 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
        switch (placeholder[0]) {
        case 'C':
                if (starts_with(placeholder + 1, "(auto)")) {
        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);
                        return 7; /* consumed 7 bytes, "C(auto)" */
                } else {
                        int ret = parse_color(sb, placeholder, c);

diff --git a/t/t6006-rev-list-format.sh b/t/t6006-rev-list-format.sh
index b77d4c97c1102c4a9bf1313c7e9eb94a6936ac06..a1dcdb81d789cfa2d0e8fcc178311a807a608771 100755 (executable)
--- a/t/t6006-rev-list-format.sh
+++ b/t/t6006-rev-list-format.sh
@@ -184,38 +184,38 @@ commit $head1
 \e[1;31;43mfoo\e[m
 EOF
 
 \e[1;31;43mfoo\e[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
 '
 
        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
 '
 
        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
 '
 
        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
 '
 
        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
 '
 
        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_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 &&
        (
                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
 
 iconv -f utf-8 -t $test_encoding > commit-msg <<EOF
 Test printing of complex bodies