diff options
| author | Brad King <brad.king@kitware.com> | 2023-01-13 11:19:29 -0500 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2023-01-16 16:58:50 -0500 |
| commit | 9d9e8450a872a4a9ec1a74cc7a73df100c32c7e8 (patch) | |
| tree | 0ccb5c395ecf839e8d3d8252a4df0ddd563221cc /Help/manual | |
| parent | 65ed5c2ca816f8ba4068b163a2dcdab079df0038 (diff) | |
| download | cmake-9d9e8450a872a4a9ec1a74cc7a73df100c32c7e8.tar.gz | |
try_compile: Add optional LOG_DESCRIPTION to record in configure log
Issue: #23200
Diffstat (limited to 'Help/manual')
| -rw-r--r-- | Help/manual/cmake-configure-log.7.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Help/manual/cmake-configure-log.7.rst b/Help/manual/cmake-configure-log.7.rst index aa2c20c82e..98f20ff033 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" |