Help: Document configure log behavior in try_compile and try_run

This commit is contained in:
Brad King
2023-01-18 11:33:40 -05:00
parent 45f86b9990
commit 645671d36f
3 changed files with 14 additions and 0 deletions

View File

@@ -42,6 +42,11 @@ below for the meaning of other options.
Previously this was only done by the
:ref:`source file <Try Compiling Source Files>` signature.
.. versionadded:: 3.26
This command records a
:ref:`configure-log try_compile event <try_compile configure-log event>`
if the ``NO_LOG`` option is not specified.
This command also supports an alternate signature
which was present in older versions of CMake:

View File

@@ -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 <try_run configure-log event>`
if the ``NO_LOG`` option is not specified.
This command also supports an alternate signature
which was present in older versions of CMake:

View File

@@ -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``
----------------------