summaryrefslogtreecommitdiff
path: root/color.h
diff options
context:
space:
mode:
authorJohannes Sixt <j6t@kdbg.org>2009-11-27 08:42:25 +0100
committerJunio C Hamano <gitster@pobox.com>2009-11-27 00:28:40 -0800
commite7821d73bd0256bfc15c48945beded063e17c1b6 (patch)
treec06a47f92c7c3b62bcd1ea6d2331f60d3fbfe782 /color.h
parentc8e1c3d3e8ed326fe9e8ba5616db2e81a41fcc16 (diff)
downloadgit-e7821d73bd0256bfc15c48945beded063e17c1b6.tar.gz
Add a notice that only certain functions can print color escape codes
We emulate color escape codes on Windows by overriding printf, fprintf, and fputs. Warn developers that these are the only functions that can be used to print them. Signed-off-by: Johannes Sixt <j6t@kdbg.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'color.h')
-rw-r--r--color.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/color.h b/color.h
index 7d8da6fe22..3cb4b7fc89 100644
--- a/color.h
+++ b/color.h
@@ -4,6 +4,11 @@
/* "\033[1;38;5;2xx;48;5;2xxm\0" is 23 bytes */
#define COLOR_MAXLEN 24
+/*
+ * IMPORTANT: Due to the way these color codes are emulated on Windows,
+ * write them only using printf(), fprintf(), and fputs(). In particular,
+ * do not use puts() or write().
+ */
#define GIT_COLOR_NORMAL ""
#define GIT_COLOR_RESET "\033[m"
#define GIT_COLOR_BOLD "\033[1m"