diff options
author | Brad King <brad.king@kitware.com> | 2023-01-13 16:55:56 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2023-01-16 22:18:07 (GMT) |
commit | 48292c8624b901a842b6d4f8a88ca00f898e5639 (patch) | |
tree | 3fe69130b088d51d082fb842d6d3688c874455a9 /Help/manual | |
parent | d4bf7d80c618930e6b88c35d271a5b0a0656bb7b (diff) | |
download | CMake-48292c8624b901a842b6d4f8a88ca00f898e5639.zip CMake-48292c8624b901a842b6d4f8a88ca00f898e5639.tar.gz CMake-48292c8624b901a842b6d4f8a88ca00f898e5639.tar.bz2 |
try_compile: Record stack of in-progess checks in configure log
Many `try_compile` and `try_run` calls occur inside check modules
between `message(CHECK_START)` and `message(CHECK_{PASS,FAIL})` pairs.
Add a field to configure log entries to report this context.
Issue: #23200
Diffstat (limited to 'Help/manual')
-rw-r--r-- | Help/manual/cmake-configure-log.7.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/Help/manual/cmake-configure-log.7.rst b/Help/manual/cmake-configure-log.7.rst index 98f20ff..2620124 100644 --- a/Help/manual/cmake-configure-log.7.rst +++ b/Help/manual/cmake-configure-log.7.rst @@ -106,6 +106,8 @@ Every event kind is represented by a YAML mapping of the form: kind: "<kind>-v<major>" backtrace: - "<file>:<line> (<function>)" + checks: + - "Checking for something" #...event-specific keys... The keys common to all events are: @@ -119,6 +121,13 @@ The keys common to all events are: least-recent. Each node is a string specifying one location formatted as ``<file>:<line> (<function>)``. +``checks`` + An optional key that is present when the event occurred with + at least one pending :command:`message(CHECK_START)`. Its value + is a YAML block sequence reporting the stack of pending checks, + from most-recent to least-recent. Each node is a string containing + a pending check message. + Additional mapping keys are specific to each (versioned) event kind, described below. @@ -141,6 +150,8 @@ A ``try_compile-v1`` event is a YAML mapping: kind: "try_compile-v1" backtrace: - "CMakeLists.txt:123 (try_compile)" + checks: + - "Checking for something" description: "Explicit LOG_DESCRIPTION" directories: source: "/path/to/.../TryCompile-01234" @@ -212,6 +223,8 @@ A ``try_run-v1`` event is a YAML mapping: kind: "try_run-v1" backtrace: - "CMakeLists.txt:456 (try_run)" + checks: + - "Checking for something" description: "Explicit LOG_DESCRIPTION" directories: source: "/path/to/.../TryCompile-56789" |