From 645671d36f5cf0fa411d98a637f4edbc3d896c57 Mon Sep 17 00:00:00 2001 From: Brad King Date: Wed, 18 Jan 2023 11:33:40 -0500 Subject: Help: Document configure log behavior in try_compile and try_run --- Help/command/try_compile.rst | 5 +++++ Help/command/try_run.rst | 5 +++++ Help/manual/cmake-configure-log.7.rst | 4 ++++ 3 files changed, 14 insertions(+) diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst index 8f6a4eb..21b063f 100644 --- a/Help/command/try_compile.rst +++ b/Help/command/try_compile.rst @@ -42,6 +42,11 @@ below for the meaning of other options. Previously this was only done by the :ref:`source file ` signature. +.. versionadded:: 3.26 + This command records a + :ref:`configure-log try_compile event ` + if the ``NO_LOG`` option is not specified. + This command also supports an alternate signature which was present in older versions of CMake: diff --git a/Help/command/try_run.rst b/Help/command/try_run.rst index ef8ec96..7566264 100644 --- a/Help/command/try_run.rst +++ b/Help/command/try_run.rst @@ -50,6 +50,11 @@ the test project is constructed to build the source file. One or more source files must be provided. Additionally, one of ``SOURCES`` and/or ``SOURCE_FROM_*`` must precede other keywords. +.. versionadded:: 3.26 + This command records a + :ref:`configure-log try_run event ` + if the ``NO_LOG`` option is not specified. + This command also supports an alternate signature which was present in older versions of CMake: diff --git a/Help/manual/cmake-configure-log.7.rst b/Help/manual/cmake-configure-log.7.rst index 2620124..768ef7e 100644 --- a/Help/manual/cmake-configure-log.7.rst +++ b/Help/manual/cmake-configure-log.7.rst @@ -131,6 +131,8 @@ The keys common to all events are: Additional mapping keys are specific to each (versioned) event kind, described below. +.. _`try_compile configure-log event`: + Event Kind ``try_compile`` -------------------------- @@ -204,6 +206,8 @@ The keys specific to ``try_compile-v1`` mappings are: An integer specifying the build tool exit code from trying to build the test project. +.. _`try_run configure-log event`: + Event Kind ``try_run`` ---------------------- -- cgit v0.12