summaryrefslogtreecommitdiffstats
path: root/Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst
diff options
context:
space:
mode:
authorAlex Turbov <i.zaufi@gmail.com>2019-10-12 02:37:15 (GMT)
committerCraig Scott <craig.scott@crascit.com>2019-10-12 07:21:36 (GMT)
commit7cf79f44195a86a907dba770f1f7a361d00e77c2 (patch)
treea8c9b970b55979ec5eecce59aadab91036941235 /Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst
parent5bf85e25178f5d9f19d2f30cf66f088c21e1114a (diff)
downloadCMake-7cf79f44195a86a907dba770f1f7a361d00e77c2.zip
CMake-7cf79f44195a86a907dba770f1f7a361d00e77c2.tar.gz
CMake-7cf79f44195a86a907dba770f1f7a361d00e77c2.tar.bz2
message: Support logging a context with each message
Diffstat (limited to 'Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst')
-rw-r--r--Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst b/Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst
new file mode 100644
index 0000000..7ec218e
--- /dev/null
+++ b/Help/variable/CMAKE_MESSAGE_CONTEXT_SHOW.rst
@@ -0,0 +1,15 @@
+CMAKE_MESSAGE_CONTEXT_SHOW
+--------------------------
+
+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.