summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2021-04-26 15:33:39 (GMT)
committerKitware Robot <kwrobot@kitware.com>2021-04-26 15:33:49 (GMT)
commit3c1655936fec54e76d6f92ab6d37e2104db44699 (patch)
tree7e019253de87fa29873d9dcfde8acb996a7cb82b /Modules
parente69a3287256d5fb7f6f2a150f5e96ff7bcb0d9b7 (diff)
parentc5c130e675624eef03f5bcaf848810659e205ed2 (diff)
downloadCMake-3c1655936fec54e76d6f92ab6d37e2104db44699.zip
CMake-3c1655936fec54e76d6f92ab6d37e2104db44699.tar.gz
CMake-3c1655936fec54e76d6f92ab6d37e2104db44699.tar.bz2
Merge topic 'lzma-threads'
c5c130e675 cmArchiveWrite: Consolidate multiple ways to set thread count 5380d858ff liblzma: Enable multi threaded stream encoding support e9065e96dc Merge branch 'upstream-liblzma' into lzma-threads ee909a8e8b liblzma 2020-03-17 (2327a461) 741b85b42b liblzma: Revise update script to get version 5.2.5 Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Ben Boeckel <ben.boeckel@kitware.com> Merge-request: !6014
Diffstat (limited to 'Modules')
-rw-r--r--Modules/CPack.cmake25
1 files changed, 17 insertions, 8 deletions
diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake
index ef5a7d5..373a707 100644
--- a/Modules/CPack.cmake
+++ b/Modules/CPack.cmake
@@ -291,18 +291,27 @@ installers. The most commonly-used variables are:
Some compression methods used by CPack generators such as Debian or Archive
may take advantage of multiple CPU cores to speed up compression.
- ``CPACK_THREADS`` can be set to positive integer to specify how many threads
- will be used for compression. If it is set to 0, CPack will set it so that
- all available CPU cores are used.
+ ``CPACK_THREADS`` can be set to specify how many threads will be
+ used for compression.
+
+ A positive integer can be used to specify an exact desired thread count.
+
+ When given a negative integer CPack will use the absolute value
+ as the upper limit but may choose a lower value based on
+ the available hardware concurrency.
+
+ Given 0 CPack will try to use all available CPU cores.
+
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.
+ Currently only ``xz`` compression *may* take advantage of multiple cores.
+ Other compression methods ignore this value and use only one thread.
- .. note::
+ .. versionadded:: 3.21
- Official CMake binaries available on ``cmake.org`` ship with a ``liblzma``
- that does not support parallel compression.
+ Official CMake binaries available on ``cmake.org`` now ship
+ with a ``liblzma`` that supports parallel compression.
+ Older versions did not.
Variables for Source Package Generators
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^