Browse Source

Merge topic 'doc-package-presets-no-effect-keywords'

60a921dce4 Help: Note that some packaging preset keywords don't work as expected

Acked-by: Kitware Robot <[email protected]>
Merge-request: !10997
Brad King 4 months ago
parent
commit
a4ef872a24
1 changed files with 16 additions and 0 deletions
  1. 16 0
      Help/manual/cmake-presets.7.rst

+ 16 - 0
Help/manual/cmake-presets.7.rst

@@ -1083,9 +1083,25 @@ fields:
 ``packageName``
   An optional string representing the package name.
 
+  .. note::
+
+    Due to problems with the implementation, this field does not affect the
+    name of the final package file produced.  Other aspects of the package
+    may use the value though, leading to inconsistencies.
+    A future CMake release may address this problem, but until then, it is
+    recommended that this field not be used.
+
 ``packageVersion``
   An optional string representing the package version.
 
+  .. note::
+
+    Due to problems with the implementation, this field does not affect the
+    name of the final package file produced.  Other aspects of the package
+    may use the value though, leading to inconsistencies.
+    A future CMake release may address this problem, but until then, it is
+    recommended that this field not be used.
+
 ``packageDirectory``
   An optional string representing the directory in which to place the package.