diff options
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/try_compile.rst | 10 | ||||
| -rw-r--r-- | Help/command/try_run.rst | 2 | ||||
| -rw-r--r-- | Help/manual/cmake-configure-log.7.rst | 6 | ||||
| -rw-r--r-- | Help/release/dev/configure-log.rst | 4 |
4 files changed, 22 insertions, 0 deletions
diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst index 52c0ae8..208be46 100644 --- a/Help/command/try_compile.rst +++ b/Help/command/try_compile.rst @@ -18,6 +18,7 @@ Try Compiling Whole Projects SOURCE_DIR <srcdir> [BINARY_DIR <bindir>] [TARGET <targetName>] + [LOG_DESCRIPTION <text>] [NO_CACHE] [CMAKE_FLAGS <flags>...] [OUTPUT_VARIABLE <var>]) @@ -47,6 +48,7 @@ which was present in older versions of CMake: try_compile(<resultVar> <bindir> <srcdir> <projectName> [<targetName>] + [LOG_DESCRIPTION <text>] [NO_CACHE] [CMAKE_FLAGS <flags>...] [OUTPUT_VARIABLE <var>]) @@ -63,6 +65,7 @@ Try Compiling Source Files SOURCE_FROM_CONTENT <name> <content> | SOURCE_FROM_VAR <name> <var> | SOURCE_FROM_FILE <name> <path> >... + [LOG_DESCRIPTION <text>] [NO_CACHE] [CMAKE_FLAGS <flags>...] [COMPILE_DEFINITIONS <defs>...] @@ -115,6 +118,7 @@ which was present in older versions of CMake: .. code-block:: cmake try_compile(<resultVar> <bindir> <srcfile|SOURCES srcfile...> + [LOG_DESCRIPTION <text>] [NO_CACHE] [CMAKE_FLAGS <flags>...] [COMPILE_DEFINITIONS <defs>...] @@ -171,6 +175,12 @@ The options are: set the :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property in the generated project, depending on the :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` variable. +``LOG_DESCRIPTION <text>`` + .. versionadded:: 3.26 + + Specify a non-empty text description of the purpose of the check. + This is recorded in the :manual:`cmake-configure-log(7)` entry. + ``NO_CACHE`` .. versionadded:: 3.25 diff --git a/Help/command/try_run.rst b/Help/command/try_run.rst index cd41a4b..ab4742e 100644 --- a/Help/command/try_run.rst +++ b/Help/command/try_run.rst @@ -17,6 +17,7 @@ Try Compiling and Running Source Files SOURCE_FROM_CONTENT <name> <content> | SOURCE_FROM_VAR <name> <var> | SOURCE_FROM_FILE <name> <path> >... + [LOG_DESCRIPTION <text>] [NO_CACHE] [CMAKE_FLAGS <flags>...] [COMPILE_DEFINITIONS <defs>...] @@ -55,6 +56,7 @@ which was present in older versions of CMake: try_run(<runResultVar> <compileResultVar> <bindir> <srcfile|SOURCES srcfile...> + [LOG_DESCRIPTION <text>] [NO_CACHE] [CMAKE_FLAGS <flags>...] [COMPILE_DEFINITIONS <defs>...] diff --git a/Help/manual/cmake-configure-log.7.rst b/Help/manual/cmake-configure-log.7.rst index aa2c20c..98f20ff 100644 --- a/Help/manual/cmake-configure-log.7.rst +++ b/Help/manual/cmake-configure-log.7.rst @@ -141,6 +141,7 @@ A ``try_compile-v1`` event is a YAML mapping: kind: "try_compile-v1" backtrace: - "CMakeLists.txt:123 (try_compile)" + description: "Explicit LOG_DESCRIPTION" directories: source: "/path/to/.../TryCompile-01234" binary: "/path/to/.../TryCompile-01234" @@ -153,6 +154,10 @@ A ``try_compile-v1`` event is a YAML mapping: The keys specific to ``try_compile-v1`` mappings are: +``description`` + An optional key that is present when the ``LOG_DESCRIPTION <text>`` option + was used. Its value is a string containing the description ``<text>``. + ``directories`` A mapping describing the directories associated with the compilation attempt. It has the following keys: @@ -207,6 +212,7 @@ A ``try_run-v1`` event is a YAML mapping: kind: "try_run-v1" backtrace: - "CMakeLists.txt:456 (try_run)" + description: "Explicit LOG_DESCRIPTION" directories: source: "/path/to/.../TryCompile-56789" binary: "/path/to/.../TryCompile-56789" diff --git a/Help/release/dev/configure-log.rst b/Help/release/dev/configure-log.rst index 34b8fb3..298137b 100644 --- a/Help/release/dev/configure-log.rst +++ b/Help/release/dev/configure-log.rst @@ -6,3 +6,7 @@ Configure Log * The :manual:`cmake-file-api(7)` gained a new "configureLog" object kind that enables stable access to the :manual:`cmake-configure-log(7)`. + +* The :command:`try_compile` and :command:`try_run` commands gained + a ``LOG_DESCRIPTION`` option specifying text to be recorded in the + :manual:`cmake-configure-log(7)`. |