From: Junio C Hamano <gitster@pobox.com>
To: "git\@vger.kernel.org" <git@vger.kernel.org>
Cc: Nguyen Thai Ngoc Duy <pclouds@gmail.com>, "Srb\,
Michal" <michal.srb11@imperial.ac.uk>, Jeff King <peff@peff.net>
Subject: [PATCH] log --format: teach %C(auto,black) to paint it black only on terminals
Date: Mon, 17 Dec 2012 00:40:55 -0800 [thread overview]
Message-ID: <7vobhtm5pk.fsf_-_@alter.siamese.dyndns.org> (raw)
In-Reply-To: <7v7gojtbgr.fsf@alter.siamese.dyndns.org> (Junio C. Hamano's message of "Sat, 15 Dec 2012 10:30:12 -0800")
Traditionally, %C(color attr) always emitted the ANSI color
sequence; it was up to the scripts that wanted to conditionally
color their output to omit %C(...) specifier when they do not want
colors.
Optionally allow "auto," to be prefixed to the color, so that the
output is colored iff it goes to the terminal.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
* This time with minimum test and documentation.
Documentation/pretty-formats.txt | 4 +++-
pretty.c | 13 ++++++++++---
t/t6006-rev-list-format.sh | 30 ++++++++++++++++++++++++++----
3 files changed, 39 insertions(+), 8 deletions(-)
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index d9edded..2af017c 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -144,7 +144,9 @@ The placeholders are:
- '%Cgreen': switch color to green
- '%Cblue': switch color to blue
- '%Creset': reset color
-- '%C(...)': color specification, as described in color.branch.* config option
+- '%C(...)': color specification, as described in color.branch.* config option;
+ adding `auto,` at the beginning will emit color only when the
+ output is going to a terminal
- '%m': left, right or boundary mark
- '%n': newline
- '%%': a raw '%'
diff --git a/pretty.c b/pretty.c
index dba6828..b9fd972 100644
--- a/pretty.c
+++ b/pretty.c
@@ -960,12 +960,19 @@ static size_t format_commit_one(struct strbuf *sb, const char *placeholder,
switch (placeholder[0]) {
case 'C':
if (placeholder[1] == '(') {
- const char *end = strchr(placeholder + 2, ')');
+ const char *begin = placeholder + 2;
+ const char *end = strchr(begin, ')');
char color[COLOR_MAXLEN];
+
if (!end)
return 0;
- color_parse_mem(placeholder + 2,
- end - (placeholder + 2),
+ if (!memcmp(begin, "auto,", 5)) {
+ if (!want_color(-1))
+ return end - placeholder + 1;
+ begin += 5;
+ }
+ color_parse_mem(begin,
+ end - begin,
"--pretty format", color);
strbuf_addstr(sb, color);
return end - placeholder + 1;
diff --git a/t/t6006-rev-list-format.sh b/t/t6006-rev-list-format.sh
index f94f0c4..bfcc1c6 100755
--- a/t/t6006-rev-list-format.sh
+++ b/t/t6006-rev-list-format.sh
@@ -11,12 +11,12 @@ touch foo && git add foo && git commit -m "added foo" &&
'
# usage: test_format name format_string <expected_output
-test_format() {
+test_format () {
cat >expect.$1
test_expect_success "format $1" "
-git rev-list --pretty=format:'$2' master >output.$1 &&
-test_cmp expect.$1 output.$1
-"
+ git rev-list --pretty=format:'$2'${3:+ $3} master >output.$1 &&
+ test_cmp expect.$1 output.$1
+ "
}
test_format percent %%h <<'EOF'
@@ -124,6 +124,28 @@ commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
^[[1;31;43mfoo^[[m
EOF
+test_format advanced-colors-auto \
+ '%C(auto,red yellow bold)foo%C(auto,reset)' --color <<'EOF'
+commit 131a310eb913d107dd3c09a65d1651175898735d
+foo
+commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
+foo
+EOF
+
+# %C(auto,...) should trump --color=always
+#
+# NEEDSWORK: --color=never should also be tested but we need to run a
+# similar test under pseudo-terminal with test_terminal which is too
+# much hassle for its worth.
+
+test_format advanced-colors-forced \
+ '%C(auto,red yellow bold)foo%C(auto,reset)' --color=always <<'EOF'
+commit 131a310eb913d107dd3c09a65d1651175898735d
+foo
+commit 86c75cfd708a0e5868dc876ed5b8bb66c80b4873
+foo
+EOF
+
cat >commit-msg <<'EOF'
Test printing of complex bodies
--
1.8.1.rc2.126.ge9b7782
next prev parent reply other threads:[~2012-12-17 8:41 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <72BB37CB88C48F4B925365539F1EE46C182613A9@icexch-m3.ic.ac.uk>
2012-12-12 17:35 ` FW: Git log --graph doesn't output color when redirected Srb, Michal
2012-12-13 13:13 ` Jeff King
2012-12-13 15:34 ` Srb, Michal
2012-12-15 3:23 ` Nguyen Thai Ngoc Duy
2012-12-15 10:16 ` Jeff King
2012-12-15 18:30 ` Junio C Hamano
2012-12-17 8:40 ` Junio C Hamano [this message]
2012-12-17 11:44 ` [PATCH] log --format: teach %C(auto,black) to paint it black only on terminals Nguyen Thai Ngoc Duy
2012-12-17 12:13 ` Jeff King
2012-12-17 19:34 ` Junio C Hamano
2012-12-17 19:49 ` Jeff King
2012-12-17 20:03 ` Junio C Hamano
2012-12-17 22:55 ` Jeff King
2012-12-17 22:55 ` [PATCH 1/2] t6006: clean up whitespace Junio C Hamano
2012-12-17 22:59 ` Jeff King
2012-12-17 22:56 ` Jeff King
2012-12-17 22:56 ` [PATCH 2/2] log --format: teach %C(auto,black) to respect color config Jeff King
2012-12-17 12:40 ` [PATCH] log --format: teach %C(auto,black) to paint it black only on terminals Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7vobhtm5pk.fsf_-_@alter.siamese.dyndns.org \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=michal.srb11@imperial.ac.uk \
--cc=pclouds@gmail.com \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).