From c8e319d08cc0b9d88e434f3fd0f79af8fc6395c9 Mon Sep 17 00:00:00 2001 From: Martin Duffy Date: Tue, 11 Feb 2025 11:53:19 -0500 Subject: instrumentation: Add experimental notes to docs --- Help/command/cmake_instrumentation.rst | 5 +++++ Help/manual/cmake-instrumentation.7.rst | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/Help/command/cmake_instrumentation.rst b/Help/command/cmake_instrumentation.rst index a859ff3..22e77ea 100644 --- a/Help/command/cmake_instrumentation.rst +++ b/Help/command/cmake_instrumentation.rst @@ -3,6 +3,11 @@ cmake_instrumentation .. versionadded:: 4.0 +.. note:: + + This command is only available when experimental support for instrumentation + has been enabled by the ``CMAKE_EXPERIMENTAL_INSTRUMENTATION`` gate. + Enables interacting with the :manual:`CMake Instrumentation API `. diff --git a/Help/manual/cmake-instrumentation.7.rst b/Help/manual/cmake-instrumentation.7.rst index b5431f7..7b2d1e6 100644 --- a/Help/manual/cmake-instrumentation.7.rst +++ b/Help/manual/cmake-instrumentation.7.rst @@ -12,6 +12,11 @@ cmake-instrumentation(7) Introduction ============ +.. note:: + + This feature is only available when experimental support for instrumentation + has been enabled by the ``CMAKE_EXPERIMENTAL_INSTRUMENTATION`` gate. + The CMake Instrumentation API allows for the collection of timing data, target information and system diagnostic information during the configure, generate, build, test and install steps for a CMake project. -- cgit v0.12