Browse Source

Help: Add cxxModuleBmi details missing from file API and release notes

Fixes: #27028
Craig Scott 4 months ago
parent
commit
da73f6b058
2 changed files with 26 additions and 0 deletions
  1. 22 0
      Help/manual/cmake-file-api.7.rst
  2. 4 0
      Help/release/3.26.rst

+ 22 - 0
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,

+ 4 - 0
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)`.