dilim/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-08-05 07:10:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

instrumentation: Clarify API and Data version distinction

Browse Source 
The instrumentation docs were unclear about the difference between API
and Data version, with the hierarchy of the table of contents being
particularly misleading.

Rework `cmake-instrumentation` manual and `cmake_instrumentation` command
documentation to be more clear.
This commit is contained in:
Martin Duffy
2026-05-20 13:45:52 -04:00
parent ba78bdd141
commit 1d0f587062
2 changed files with 48 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Help/command/cmake_instrumentation.rst
View File

@@ -20,9 +20,9 @@ This allows for configuring instrumentation at the project-level.
)
The ``API_VERSION`` and ``DATA_VERSION`` must always be given. Currently, the
only supported value for both fields is 1. See :ref:`cmake-instrumentation API v1`
for details of the ``API_VERSION`` and :ref:`cmake-instrumentation Data v1` for details
of the ``DATA_VERSION``.
only supported value for both fields is 1. See
:ref:`cmake-instrumentation API v1` for details of the ``API_VERSION`` and
:ref:`cmake-instrumentation Data Version` for details of the ``DATA_VERSION``.
Each of the optional keywords ``HOOKS``, ``OPTIONS``, and ``CALLBACK``
correspond to one of the parameters to the :ref:`cmake-instrumentation v1 Query Files`.