Explorar el Código

Help: Fix documentation for CTEST_USE_*_INSTRUMENTATION variables

Martin Duffy hace 2 meses
padre
commit
2e05695b30

+ 1 - 1
Help/envvar/CTEST_USE_INSTRUMENTATION.rst

@@ -10,6 +10,6 @@ CTEST_USE_INSTRUMENTATION
    This feature is only available when experimental support for instrumentation
    This feature is only available when experimental support for instrumentation
    has been enabled by the ``CMAKE_EXPERIMENTAL_INSTRUMENTATION`` gate.
    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
 :manual:`instrumentation <cmake-instrumentation(7)>` for CTest in
 :ref:`Dashboard Client` mode.
 :ref:`Dashboard Client` mode.

+ 4 - 3
Help/envvar/CTEST_USE_VERBOSE_INSTRUMENTATION.rst

@@ -10,8 +10,9 @@ CTEST_USE_VERBOSE_INSTRUMENTATION
    This feature is only available when experimental support for instrumentation
    This feature is only available when experimental support for instrumentation
    has been enabled by the ``CMAKE_EXPERIMENTAL_INSTRUMENTATION`` gate.
    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`
 See also :envvar:`CTEST_USE_INSTRUMENTATION`

+ 1 - 2
Help/manual/cmake-instrumentation.7.rst

@@ -98,8 +98,7 @@ Enabling Instrumentation for CDash Submissions
 ----------------------------------------------
 ----------------------------------------------
 
 
 You can enable instrumentation when using CTest in :ref:`Dashboard Client`
 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.
 Doing so automatically enables the ``dynamicSystemInformation`` option.
 
 
 The following table shows how each type of instrumented command gets mapped
 The following table shows how each type of instrumented command gets mapped