[PATCH v3 5/5] builtin/config: do not spawn pager when printing color codes
- From
Patrick Steinhardt <ps@pks.im>
- Date
- Sep 18, 2025, 06:14 UTC
- Message-ID
- <20250918-pks-config-color-v3-5-08ea618cae26@pks.im>
- In-Reply-To
- <20250918-pks-config-color-v3-0-08ea618cae26@pks.im>
With `git config get --type=color` the user asks us to parse a specific configuration key and turn the value into an ANSI color escape sequence. The printed string can then for example be used as part of shell scripts to reuse the same colors as Git.
Right now though we set up the auto-pager, which means that the string may be written to the pager instead of directly to the terminal. This behaviour is problematic for two reasons:
- Color codes are meant for direct terminal output; writing them into
a pager does not seem like a sensible thing to do without additional
text. - It is inconsistent with `git config --get-color`, which never uses a
pager, despite the fact that we claim `git config get --type=color`
to be a drop-in replacement in git-config(1).Fix this by disabling the pager when outputting color sequences.
Signed-off-by: Patrick Steinhardt <ps@pks.im> --- builtin/config.c | 3 ++- t/t1300-config.sh | 9 +++++++++ 2 files changed, 11 insertions(+), 1 deletion(-)
diff --git a/builtin/config.c b/builtin/config.c index f50c11df57..6708d91814 100644 --- a/builtin/config.c +++ b/builtin/config.c @@ -919,7 +919,8 @@ static int cmd_config_get(int argc, const char **argv, const char *prefix, location_options_init(&location_opts, prefix); display_options_init(&display_opts); - setup_auto_pager("config", 1); + if (display_opts.type != TYPE_COLOR) + setup_auto_pager("config", 1); if (url) ret = get_urlmatch(&location_opts, &display_opts, argv[0], url); diff --git a/t/t1300-config.sh b/t/t1300-config.sh index 3cf5d17aba..358d636379 100755 --- a/t/t1300-config.sh +++ b/t/t1300-config.sh @@ -9,6 +9,7 @@ GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME . ./test-lib.sh +. "$TEST_DIRECTORY"/lib-terminal.sh for mode in legacy subcommands do @@ -1099,6 +1100,14 @@ test_expect_success 'get --type=color with default value only' ' test_cmp actual.raw actual-subcommand.raw ' +test_expect_success TTY 'get --type=color does not use a pager' ' + test_config core.pager "echo foobar" && + test_terminal git config get --type=color --default="red" "" >actual.raw && + test_decode_color <actual.raw >actual && + echo "<RED>" >expect && + test_cmp expect actual +' + test_expect_success 'set --type=color' ' cat >expect <<\EOF && [foo]
-- 2.51.0.534.gc79095c0ca.dirty