mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-08 23:00:07 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Clarify CLICOLOR and CLICOLOR_FORCE environment variables

Browse Source 
Document variable precedence.

Link to third-party documentation of the convention these follow.
For now, link to an older view of the documentation since our
implementation has not been updated for `NO_COLOR`.

Issue: #26458
This commit is contained in:
Brad King
2024-11-19 10:45:42 -05:00
parent 908b2ca27c
commit d94e3eac10
2 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Help/envvar/CLICOLOR.rst
View File

@@ -5,10 +5,15 @@ CLICOLOR
.. include:: ENV_VAR.txt
Set to ``0`` to tell CMake command-line tools not to print color
Set to ``0`` to tell command-line tools not to print color
messages even if connected to a terminal.
This is a `common convention`_ among command-line tools in general.
See also the :envvar:`CLICOLOR_FORCE` environment variable.
:envvar:`CLICOLOR_FORCE`, if activated, takes precedence over
:envvar:`!CLICOLOR`.
See the :variable:`CMAKE_COLOR_DIAGNOSTICS` variable to control
color in a generated build system.
.. _`common convention`: https://web.archive.org/web/20230417221418/https://bixense.com/clicolors/

7
Help/envvar/CLICOLOR_FORCE.rst
View File

@@ -5,10 +5,15 @@ CLICOLOR_FORCE
.. include:: ENV_VAR.txt
Set to a non-empty value, other than ``0``, to tell CMake command-line
Set to a non-empty value, other than ``0``, to tell command-line
tools to print color messages even if not connected to a terminal.
This is a `common convention`_ among command-line tools in general.
See also the :envvar:`CLICOLOR` environment variable.
:envvar:`!CLICOLOR_FORCE`, if activated, takes precedence over
:envvar:`CLICOLOR`.
See the :variable:`CMAKE_COLOR_DIAGNOSTICS` variable to control
color in a generated build system.
.. _`common convention`: https://web.archive.org/web/20230417221418/https://bixense.com/clicolors/