[PATCH] Add a notice that only certain functions can print color escape codes
- From
Johannes Sixt <j.sixt@viscovery.net>
- Date
- Nov 27, 2009, 07:00 UTC
- Message-ID
- <4B0F78F1.4040101@viscovery.net>
- In-Reply-To
- <7vy6lt6rh3.fsf@alter.siamese.dyndns.org>
From: Johannes Sixt <j6t@kdbg.org>
We emulate color escape codes on Windows by overriding printf, fprintf, and fputs. Warn users that these are the only functions that can be used to print them.
Signed-off-by: Johannes Sixt <j6t@kdbg.org> --- Junio C Hamano schrieb:
Show 10 quoted lines
> Johannes Sixt <j.sixt@viscovery.net> writes: > >> Michael J Gruber schrieb: >>> * Is there any policy regarding use of putchar/puts vs. printf? >> If the printed string contains color escapes that should be obeyed, you >> can use only fputs, printf, and fprintf. You should not use puts or putchar. > > This msysgit-imposed restriction is something even I do not remember > offhand. Could you please document it somewhere in a file any developer > would get by checking out the 'master' branch of git.git?
Like this?
color.h | 5 +++++ 1 files changed, 5 insertions(+), 0 deletions(-)
diff --git a/color.h b/color.h index 7d8da6f..edeaa3e 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. + */ #define GIT_COLOR_NORMAL "" #define GIT_COLOR_RESET "\033[m" #define GIT_COLOR_BOLD "\033[1m"
-- 1.6.6.rc0.43.g50037