dilim/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-06-24 08:47:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

instrumentation: Fix stale version references in documentation

Browse Source 
Four per-format version descriptions in cmake-instrumentation.7.rst
still claimed the data version is always 1.0, contradicting both the
authoritative Data Version paragraph (which says 1.1) and the JSON
schemas (which accept minor versions 0 and 1).

Replace the hardcoded version claims with a reference to the Data
Version section, so these lines remain correct as future minor
versions are added without requiring additional doc updates.

Fixes: #27889
This commit is contained in:
Daksh Mamodiya
2026-06-18 15:56:10 +02:00
parent d9c35d02bb
commit 330b36dddc
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -260,8 +260,9 @@ key is required, but all other fields are optional.
for the most recent minor version, even if an earlier minor version is
requested.
Currently, the only supported version is ``1.0``. Query files with an unknown
data version will be ignored.
Currently, the only supported major version is ``1``. Query files
requesting a minor version up to the maximum described in `Data Version`_
are accepted; those with an unknown data version will be ignored.
``callbacks``
A list of command-line strings for `Callbacks`_ to handle collected
@@ -437,8 +438,8 @@ Snippet files have a filename with the syntax
``<role>-<hash>-<timestamp>.json`` and contain the following data:
``version``
The `Data Version`_ of the snippet file. Currently the version is
always ``{ "major": 1, "minor": 0 }``.
The `Data Version`_ of the snippet file, written as
``{ "major": 1, "minor": N }`` where ``N`` is the most recent minor version.
``command``
The full command executed. Excluded when ``role`` is ``build``.
@@ -613,8 +614,8 @@ generated whenever `Indexing`_ occurs and deleted after any user-specified
`Callbacks`_ are executed.
``version``
The `Data Version`_ of the index file. Currently this is always written as:
``{ "major": 1, "minor": 0 }``.
The `Data Version`_ of the index file, written as
``{ "major": 1, "minor": N }`` where ``N`` is the most recent minor version.
``buildDir``
The build directory of the CMake project.
@@ -716,8 +717,8 @@ corresponding to the CMake invocation responsible for generating its command.
Each CMake content file contains the following:
``version``
The `Data Version`_ of the content file. Currently the version is
always ``{ "major": 1, "minor": 0 }``.
The `Data Version`_ of the content file, written as
``{ "major": 1, "minor": N }`` where ``N`` is the most recent minor version.
``project``
The value of :variable:`CMAKE_PROJECT_NAME`.