summaryrefslogtreecommitdiff
path: root/Modules/CPack.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-02-22 15:31:37 -0500
committerBrad King <brad.king@kitware.com>2022-02-22 15:31:37 -0500
commit29f63129be470e44b99f498576e311111648a620 (patch)
tree43ad76b6c198f6d30fce73aadab6c52514d05063 /Modules/CPack.cmake
parent176407736ec13715f42d6a696daa5f4779eeec4c (diff)
downloadcmake-29f63129be470e44b99f498576e311111648a620.tar.gz
CPack: Format CPACK_THREADS compression methods as a definition list
Prepare to add more entries beyond `xz`.
Diffstat (limited to 'Modules/CPack.cmake')
-rw-r--r--Modules/CPack.cmake17
1 files changed, 11 insertions, 6 deletions
diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake
index 6650f7c155..e267ed039f 100644
--- a/Modules/CPack.cmake
+++ b/Modules/CPack.cmake
@@ -304,14 +304,19 @@ installers. The most commonly-used variables are:
By default ``CPACK_THREADS`` is set to ``1``.
- Currently only ``xz`` compression *may* take advantage of multiple cores.
- Other compression methods ignore this value and use only one thread.
+ The following compression methods may take advantage of multiple cores:
+
+ ``xz``
+ Supported if CMake is built with a ``liblzma`` that supports
+ parallel compression.
- .. versionadded:: 3.21
+ .. versionadded:: 3.21
- Official CMake binaries available on ``cmake.org`` now ship
- with a ``liblzma`` that supports parallel compression.
- Older versions did not.
+ Official CMake binaries available on ``cmake.org`` now ship
+ with a ``liblzma`` that supports parallel compression.
+ Older versions did not.
+
+ Other compression methods ignore this value and use only one thread.
Variables for Source Package Generators
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^