summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake-configure-log.7.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-01-16 19:32:36 (GMT)
committerBrad King <brad.king@kitware.com>2023-01-18 16:37:11 (GMT)
commita78cba51978fbc805993604767c1902a249482ff (patch)
treeb4df0181bf56b68135e52c3745f60ab10c9d229c /Help/manual/cmake-configure-log.7.rst
parent645671d36f5cf0fa411d98a637f4edbc3d896c57 (diff)
downloadCMake-a78cba51978fbc805993604767c1902a249482ff.zip
CMake-a78cba51978fbc805993604767c1902a249482ff.tar.gz
CMake-a78cba51978fbc805993604767c1902a249482ff.tar.bz2
message: Add CONFIGURE_LOG mode to record a message in the configure log
Provide a replacement for `file(APPEND .../CMake{Output,Error}.log)` that records messages in the configure log. Issue: #23200
Diffstat (limited to 'Help/manual/cmake-configure-log.7.rst')
-rw-r--r--Help/manual/cmake-configure-log.7.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/Help/manual/cmake-configure-log.7.rst b/Help/manual/cmake-configure-log.7.rst
index 768ef7e..a9c185d 100644
--- a/Help/manual/cmake-configure-log.7.rst
+++ b/Help/manual/cmake-configure-log.7.rst
@@ -131,6 +131,38 @@ The keys common to all events are:
Additional mapping keys are specific to each (versioned) event kind,
described below.
+.. _`message configure-log event`:
+
+Event Kind ``message``
+----------------------
+
+The :command:`message(CONFIGURE_LOG)` command logs ``message`` events.
+
+There is only one ``message`` event major version, version 1.
+
+.. _`message-v1 event`:
+
+``message-v1`` Event
+^^^^^^^^^^^^^^^^^^^^
+
+A ``message-v1`` event is a YAML mapping:
+
+.. code-block:: yaml
+
+ kind: "message-v1"
+ backtrace:
+ - "CMakeLists.txt:123 (message)"
+ checks:
+ - "Checking for something"
+ message: |
+ # ...
+
+The keys specific to ``message-v1`` mappings are:
+
+``message``
+ A YAML literal block scalar containing the message text,
+ represented using our `Text Block Encoding`_.
+
.. _`try_compile configure-log event`:
Event Kind ``try_compile``