path: root/Documentation/git-for-each-ref.txt
diff options
authorJeff King <>2017-10-03 13:45:47 (GMT)
committerJunio C Hamano <>2017-10-04 02:35:29 (GMT)
commit0c88bf50502e2be7d7d8965052d77bbf08e1d519 (patch)
tree2e0526a67f059be8fce0eaac254232845bdb9544 /Documentation/git-for-each-ref.txt
parent8126b1267c9b3c8cdc79daf56492972b82f0a57d (diff)
provide --color option for all ref-filter users
When ref-filter learned about want_color() in 11b087adfd (ref-filter: consult want_color() before emitting colors, 2017-07-13), it became useful to be able to turn colors off and on for specific commands. For git-branch, you can do so with --color/--no-color. But for git-for-each-ref and git-tag, the other users of ref-filter, you have no option except to tweak the "color.ui" config setting. Let's give both of these commands the usual color command-line options. This is a bit more obvious as a method for overriding the config. And it also prepares us for the behavior of "always" changing (so that we are still left with a way of forcing color when our output goes to a non-terminal). Signed-off-by: Jeff King <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-for-each-ref.txt')
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index cc42c12..b92ebd0 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -55,6 +55,11 @@ OPTIONS
literally, in the latter case matching completely or from the
beginning up to a slash.
+ Respect any colors specified in the `--format` option. The
+ `<when>` field must be one of `always`, `never`, or `auto` (if
+ `<when>` is absent, behave as if `always` was given).