From da73f6b058f06bf98275b8819f2050c9ef259986 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Fri, 4 Jul 2025 10:30:06 +1000 Subject: [PATCH] Help: Add cxxModuleBmi details missing from file API and release notes Fixes: #27028 --- Help/manual/cmake-file-api.7.rst | 22 ++++++++++++++++++++++ Help/release/3.26.rst | 4 ++++ 2 files changed, 26 insertions(+) diff --git a/Help/manual/cmake-file-api.7.rst b/Help/manual/cmake-file-api.7.rst index 2b6bcb4ac8..058e4aaabf 100644 --- a/Help/manual/cmake-file-api.7.rst +++ b/Help/manual/cmake-file-api.7.rst @@ -822,6 +822,13 @@ with members: This type was added in codemodel version 2.4. + ``cxxModuleBmi`` + An :command:`install(TARGETS)` call with ``CXX_MODULES_BMI``. + The ``destination`` member is populated and the ``isOptional`` member + may exist. This type has an additional ``cxxModuleBmiTarget`` member. + + This type was added in codemodel version 2.5. + ``isExcludeFromAll`` Optional member that is present with boolean value ``true`` when :command:`install` is called with the ``EXCLUDE_FROM_ALL`` option. @@ -934,6 +941,21 @@ with members: This field was added in codemodel version 2.4. + ``cxxModuleBmiTarget`` + Optional member that is present when ``type`` is ``cxxModuleBmi``. + The value is a JSON object with members: + + ``id`` + A string uniquely identifying the target. This matches + the ``id`` member of the target in the main "codemodel" + object's ``targets`` array. + + ``index`` + An unsigned integer 0-based index into the main "codemodel" + object's ``targets`` array for the target. + + This field was added in codemodel version 2.5. + ``scriptFile`` Optional member that is present when ``type`` is ``script``. The value is a string specifying the path to the script file on disk, diff --git a/Help/release/3.26.rst b/Help/release/3.26.rst index 72ffad8cf5..97cf4264ea 100644 --- a/Help/release/3.26.rst +++ b/Help/release/3.26.rst @@ -42,6 +42,10 @@ File-Based API gained a new ``fileSets`` field and associated ``fileSetIndex`` field to ``sources`` objects. +* The :manual:`cmake-file-api(7)` "codemodel" version 2 "directory" + object ``installers`` field gained a new ``cxxModuleBmi`` installer type + and an associated ``cxxModuleBmiTarget`` field. + * The :manual:`cmake-file-api(7)` gained a new "configureLog" object kind that enables stable access to the :manual:`cmake-configure-log(7)`.