Added documentation

SINTEF · Dec 19, 2023 · 3dedced · 3dedced
1 parent e252dc5
commit 3dedced
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/doc/user_guide/environment_variables.md b/doc/user_guide/environment_variables.md
@@ -121,8 +121,11 @@ Environment variables for controlling error handling
       - "4" | "ignore-new"  : ignore new error message
       - otherwise           : append new error message to the old one
 
-  - **ERR_COLOR**: If defined, error messages to stdout and stderr will be
-    written in colour.
+  - **ERR_COLOR**: Whether to print error messages in colour. May be:
+      - "0" | "never"       : print errors colour-coded
+      - "1" | "always"      : print errors not colour-coded
+      - otherwise           : only print errors colour-coded if the error
+                              stream is a terminal
 
 
 Path handling when using the pre-packaged wheel (Linux, Windows)

diff --git a/src/utils/err.c b/src/utils/err.c
@@ -641,10 +641,9 @@ int err_get_color_coded()
   if (tls->err_color_mode < 0) {
     char *mode = getenv("ERR_COLOR");
     tls->err_color_mode =
-      (!mode || !*mode)                 ? errColorAuto :
-      (strcmp(mode, "auto") == 0)       ? errColorAuto :
-      (strcmp(mode, "always") == 0)     ? errColorAlways :
-      (strcmp(mode, "never") == 0)      ? errColorNever :
+      (!mode || !*mode)                                      ? errColorAuto :
+      (strcmp(mode, "never") == 0 || strcmp(mode, "0") == 0) ? errColorNever :
+      (strcmp(mode, "always") == 0 || strcmp(mode,"1") == 0) ? errColorAlways :
       errColorAuto;
   }