Update manual

ocaml · Aug 6, 2021 · fdaaa86 · fdaaa86
1 parent 2339c16
commit fdaaa86
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 20 deletions.
diff --git a/Changes b/Changes
@@ -42,10 +42,10 @@ Working version
 - #10524: Directive argument type error now shows expected and received type.
   (Wiktor Kuchta, review by Gabriel Scherer)
 
-- #10560: Disable colors if the env variable `NO_COLOR` is set.  If
-  `OCAML_COLOR` is set, its setting takes precedence over `NO_COLOR`.
-  (Nicolás Ojeda Bär, report by Gabriel Scherer, review by Daniel Bünzli and
-  Gabriel Scherer)
+- #10560: When the color setting is `auto` (the default), colors are disabled if
+  the env variable `NO_COLOR` is set.
+  (Nicolás Ojeda Bär, report by Gabriel Scherer, review by Daniel Bünzli,
+  Gabriel Scherer, and David Allsopp)
 
 ### Manual and documentation:
 

diff --git a/man/ocaml.m b/man/ocaml.m
@@ -258,14 +258,12 @@ use heuristics to enable colors only if the output supports them (an
 .B auto,
 and the current heuristic
 checks that the "TERM" environment variable exists and is
-not empty or "dumb", and that isatty(stderr) holds.
+not empty or "dumb", that isatty(stderr) holds, and that
+"NO_COLOR" is not set.
 
 The environment variable "OCAML_COLOR" is considered if \-color is not
 provided. Its values are auto/always/never as above.
 
-If \-color is not provided, "OCAML_COLOR" is not set and the environment
-variable "NO_COLOR" is set, then color output is disabled.
-
 .TP
 .BI \-error\-style \ mode
 Control the way error messages and warnings are printed.

diff --git a/man/ocamlc.m b/man/ocamlc.m
@@ -272,14 +272,12 @@ use heuristics to enable colors only if the output supports them (an
 .B auto,
 and the current heuristic
 checks that the "TERM" environment variable exists and is
-not empty or "dumb", and that isatty(stderr) holds.
+not empty or "dumb", that isatty(stderr) holds, and that
+"NO_COLOR" is not set.
 
 The environment variable "OCAML_COLOR" is considered if \-color is not
 provided. Its values are auto/always/never as above.
 
-If \-color is not provided, "OCAML_COLOR" is not set and the environment
-variable "NO_COLOR" is set, then color output is disabled.
-
 .TP
 .BI \-error\-style \ mode
 Control the way error messages and warnings are printed.

diff --git a/man/ocamlopt.m b/man/ocamlopt.m
@@ -228,14 +228,12 @@ use heuristics to enable colors only if the output supports them (an
 .B auto,
 and the current heuristic
 checks that the "TERM" environment variable exists and is
-not empty or "dumb", and that isatty(stderr) holds.
+not empty or "dumb", that isatty(stderr) holds, and that
+"NO_COLOR" is not set.
 
 The environment variable "OCAML_COLOR" is considered if \-color is not
 provided. Its values are auto/always/never as above.
 
-If \-color is not provided, "OCAML_COLOR" is not set and the environment
-variable "NO_COLOR" is set, then color output is disabled.
-
 .TP
 .BI \-error\-style \ mode
 Control the way error messages and warnings are printed.

diff --git a/manual/src/cmds/unified-options.etex b/manual/src/cmds/unified-options.etex
@@ -128,13 +128,11 @@ The following modes are supported:
 \end{description}
 The default setting is 'auto', and the current heuristic
 checks that the "TERM" environment variable exists and is
-not empty or "dumb", and that 'isatty(stderr)' holds.
+not empty or "dumb", that 'isatty(stderr)' holds, and that
+"NO_COLOR" is not set.
 
 The environment variable "OCAML_COLOR" is considered if "-color" is not
 provided. Its values are auto/always/never as above.
-
-If "-color" is not provided, "OCAML_COLOR" is not set and the environment
-variable "NO_COLOR" is set, then color output is disabled.
 }%notop
 
 \notop{%