mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-04 21:00:17 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Fix documentation for CTEST_USE_*_INSTRUMENTATION variables

Browse Source
This commit is contained in:
Martin Duffy
2025-08-06 17:09:14 -04:00
parent bf5512097e
commit 2e05695b30
3 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Help/envvar/CTEST_USE_INSTRUMENTATION.rst
View File

@@ -10,6 +10,6 @@ CTEST_USE_INSTRUMENTATION
This feature is only available when experimental support for instrumentation
has been enabled by the ``CMAKE_EXPERIMENTAL_INSTRUMENTATION`` gate.
Setting this environment variable enables
Setting this environment variable to ``1``, ``True``, or ``ON`` enables
:manual:`instrumentation <cmake-instrumentation(7)>` for CTest in
:ref:`Dashboard Client` mode.

7
Help/envvar/CTEST_USE_VERBOSE_INSTRUMENTATION.rst
View File

@@ -10,8 +10,9 @@ CTEST_USE_VERBOSE_INSTRUMENTATION
This feature is only available when experimental support for instrumentation
has been enabled by the ``CMAKE_EXPERIMENTAL_INSTRUMENTATION`` gate.
Setting this environment variable causes CTest to report the full
command line (including arguments) to CDash for each instrumented command.
By default, CTest truncates the command line at the first space.
Setting this environment variable to ``1``, ``True``, or ``ON`` causes CTest to
report the full command line (including arguments) to CDash for each
instrumented command. By default, CTest truncates the command line at the first
space.
See also :envvar:`CTEST_USE_INSTRUMENTATION`

3
Help/manual/cmake-instrumentation.7.rst
View File

@@ -98,8 +98,7 @@ Enabling Instrumentation for CDash Submissions
----------------------------------------------
You can enable instrumentation when using CTest in :ref:`Dashboard Client`
mode by setting the :envvar:`CTEST_USE_INSTRUMENTATION` environment variable
to the current UUID for the ``CMAKE_EXPERIMENTAL_INSTRUMENTATION`` feature.
mode by setting the :envvar:`CTEST_USE_INSTRUMENTATION` environment variable.
Doing so automatically enables the ``dynamicSystemInformation`` option.
The following table shows how each type of instrumented command gets mapped