summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake-configure-log.7.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-12-12 22:59:41 (GMT)
committerBrad King <brad.king@kitware.com>2022-12-17 13:52:04 (GMT)
commitd811d86fd7f9644876e9d3605937edffa5c8a9d8 (patch)
tree7359c796a0ec5bf273eedd924a2753980176cc8d /Help/manual/cmake-configure-log.7.rst
parent02599da236fd22db0dcfb6503194e5bad086aea9 (diff)
downloadCMake-d811d86fd7f9644876e9d3605937edffa5c8a9d8.zip
CMake-d811d86fd7f9644876e9d3605937edffa5c8a9d8.tar.gz
CMake-d811d86fd7f9644876e9d3605937edffa5c8a9d8.tar.bz2
FileAPI: Add "configureLog" object kind
Provide clients with a way to get a known set of configure log event versions. Issue: #23200
Diffstat (limited to 'Help/manual/cmake-configure-log.7.rst')
-rw-r--r--Help/manual/cmake-configure-log.7.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/Help/manual/cmake-configure-log.7.rst b/Help/manual/cmake-configure-log.7.rst
index 7f395f5..f909717 100644
--- a/Help/manual/cmake-configure-log.7.rst
+++ b/Help/manual/cmake-configure-log.7.rst
@@ -73,6 +73,16 @@ they do not understand:
* If an existing build tree is re-configured with a different version of
CMake, the log may contain different versions of the same event kind.
+* If :manual:`cmake-file-api(7)` queries request one or more
+ :ref:`configureLog <file-api configureLog>` object versions,
+ the log may contain multiple entries for the same event, each
+ with a different version of its event kind.
+
+IDEs should write a :manual:`cmake-file-api(7)` query requesting a
+specific :ref:`configureLog <file-api configureLog>` object version,
+before running CMake, and then read the configure log only as described
+by the file-api reply.
+
Text Block Encoding
-------------------