diff options
| author | Brad King <brad.king@kitware.com> | 2020-04-06 12:28:04 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2020-04-06 12:28:19 (GMT) |
| commit | f0a27e44f32cbb40669dd4ec81d4029d69bc82a0 (patch) | |
| tree | 466c3a98d2c818c586e81d7665b1a2da479e3e96 /Help/cpack_gen | |
| parent | 2b9e3abcb5f55fa74ff50979176545da6c56e368 (diff) | |
| parent | b3bacf0152c15d46b5392c622b46dbfa2ad8c6c2 (diff) | |
| download | CMake-f0a27e44f32cbb40669dd4ec81d4029d69bc82a0.zip CMake-f0a27e44f32cbb40669dd4ec81d4029d69bc82a0.tar.gz CMake-f0a27e44f32cbb40669dd4ec81d4029d69bc82a0.tar.bz2 | |
Merge topic 'parallel-lzma-compression'
b3bacf0152 cmCPackArchiveGenerator: support multithreaded compression
b71d385ed4 cmCPackArchiveGenerator: support setting archive options
948aa8bd1c cmArchiveWrite: support setting archive filter options
b9c17de023 cmArchiveWrite: split out opening the file
Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Cristian Adam <cristian.adam@gmail.com>
Merge-request: !3195
Diffstat (limited to 'Help/cpack_gen')
| -rw-r--r-- | Help/cpack_gen/archive.rst | 22 | ||||
| -rw-r--r-- | Help/cpack_gen/cygwin.rst | 5 | ||||
| -rw-r--r-- | Help/cpack_gen/freebsd.rst | 5 |
3 files changed, 32 insertions, 0 deletions
diff --git a/Help/cpack_gen/archive.rst b/Help/cpack_gen/archive.rst index e9904ae..3656aa2 100644 --- a/Help/cpack_gen/archive.rst +++ b/Help/cpack_gen/archive.rst @@ -51,3 +51,25 @@ Variables specific to CPack Archive generator Enable component packaging. If enabled (ON), then the archive generator creates multiple packages. The default is OFF, which means that a single package containing files of all components is generated. + +Variables used by CPack Archive generator +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +These variables are used by the Archive generator, but are also available to +CPack generators which are essentially archives at their core. These include: + + - :cpack_gen:`CPack Cygwin Generator` + - :cpack_gen:`CPack FreeBSD Generator` + +.. variable:: CPACK_ARCHIVE_THREADS + + The number of threads to use when performing the compression. If set to + ``0``, the number of available cores on the machine will be used instead. + The default is ``1`` which limits compression to a single thread. Note that + not all compression modes support threading in all environments. Currently, + only the XZ compression may support it. + +.. note:: + + Official CMake binaries available on ``cmake.org`` ship with a ``liblzma`` + that does not support parallel compression. diff --git a/Help/cpack_gen/cygwin.rst b/Help/cpack_gen/cygwin.rst index 1c5f7af..c65653e 100644 --- a/Help/cpack_gen/cygwin.rst +++ b/Help/cpack_gen/cygwin.rst @@ -3,6 +3,11 @@ CPack Cygwin Generator Cygwin CPack generator (Cygwin). +Variables affecting the CPack Cygwin generator +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + - :variable:`CPACK_ARCHIVE_THREADS` + Variables specific to CPack Cygwin generator ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/Help/cpack_gen/freebsd.rst b/Help/cpack_gen/freebsd.rst index a8dd320..47a7784 100644 --- a/Help/cpack_gen/freebsd.rst +++ b/Help/cpack_gen/freebsd.rst @@ -3,6 +3,11 @@ CPack FreeBSD Generator The built in (binary) CPack FreeBSD (pkg) generator (Unix only) +Variables affecting the CPack FreeBSD (pkg) generator +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + - :variable:`CPACK_ARCHIVE_THREADS` + Variables specific to CPack FreeBSD (pkg) generator ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |