Files
CMake/Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst
Kitware Robot 496ec6036f Help: Add Sphinx 'versionadded' directives to each top-level document
Run the `Utilities/Sphinx/update_versions.py` script to add initial
markup to every top-level document and find module.

Issue: #19715
2020-07-06 10:23:20 -04:00

18 lines
773 B
ReStructuredText

CMAKE_MESSAGE_CONTEXT_SHOW
--------------------------
.. versionadded:: 3.17
Setting this variable to true enables showing a context with each line
logged by the :command:`message` command (see :variable:`CMAKE_MESSAGE_CONTEXT`
for how the context itself is specified).
This variable is an alternative to providing the ``--log-context`` option
on the :manual:`cmake <cmake(1)>` command line. Whereas the command line
option will apply only to that one CMake run, setting
``CMAKE_MESSAGE_CONTEXT_SHOW`` to true as a cache variable will ensure that
subsequent CMake runs will continue to show the message context.
Projects should not set ``CMAKE_MESSAGE_CONTEXT_SHOW``. It is intended for
users so that they may control whether or not to include context with messages.