https://github.com/Kitware/CMake
Tip revision: 8bd78627dd3d4d2b6f83a4b688ad97cc71840857 authored by Brad King on 30 November 2023, 18:13:15 UTC
CMake 3.28.0-rc6
CMake 3.28.0-rc6
Tip revision: 8bd7862
CMAKE_COLOR_DIAGNOSTICS.rst
CMAKE_COLOR_DIAGNOSTICS
-----------------------
.. versionadded:: 3.24
Enable color diagnostics throughout.
This variable uses three states: ``ON``, ``OFF`` and not defined.
When not defined:
* :ref:`Makefile Generators` initialize the :variable:`CMAKE_COLOR_MAKEFILE`
variable to ``ON``. It controls color buildsystem messages.
* GNU/Clang compilers are not invoked with any color diagnostics flag.
When ``ON``:
* :ref:`Makefile Generators` produce color buildsystem messages by default.
:variable:`CMAKE_COLOR_MAKEFILE` is not initialized, but may be
explicitly set to ``OFF`` to disable color buildsystem messages.
* GNU/Clang compilers are invoked with a flag enabling color diagnostics
(``-fcolor-diagnostics``).
When ``OFF``:
* :ref:`Makefile Generators` do not produce color buildsystem messages by
default. :variable:`CMAKE_COLOR_MAKEFILE` is not initialized, but may be
explicitly set to ``ON`` to enable color buildsystem messages.
* GNU/Clang compilers are invoked with a flag disabling color diagnostics
(``-fno-color-diagnostics``).
If the :envvar:`CMAKE_COLOR_DIAGNOSTICS` environment variable is set, its
value is used. Otherwise, ``CMAKE_COLOR_DIAGNOSTICS`` is not defined by
default.