summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorAsit Dhal <dhal.asitk@gmail.com>2020-09-17 17:29:31 (GMT)
committerBrad King <brad.king@kitware.com>2020-09-21 17:08:11 (GMT)
commit195d14e7818244789638fffd2087b8b2d0952622 (patch)
tree7e46f8f1f6dfbb60dc73bb600e1190369bc00bc0 /Help
parent4fc07cd369cd46fbd859f140eda971d00ac52704 (diff)
downloadCMake-195d14e7818244789638fffd2087b8b2d0952622.zip
CMake-195d14e7818244789638fffd2087b8b2d0952622.tar.gz
CMake-195d14e7818244789638fffd2087b8b2d0952622.tar.bz2
file(ARCHIVE_CREATE): Add option to control compression level
Fixes: #21125
Diffstat (limited to 'Help')
-rw-r--r--Help/command/file.rst5
-rw-r--r--Help/release/dev/file-ARCHIVE-compression-level.rst5
2 files changed, 10 insertions, 0 deletions
diff --git a/Help/command/file.rst b/Help/command/file.rst
index d77ad2d..4210bd4 100644
--- a/Help/command/file.rst
+++ b/Help/command/file.rst
@@ -987,6 +987,7 @@ Archiving
PATHS <paths>...
[FORMAT <format>]
[COMPRESSION <compression>]
+ [COMPRESSION_LEVEL <compression level>]
[MTIME <mtime>]
[VERBOSE])
@@ -1004,6 +1005,10 @@ compression. The other formats use no compression by default, but can be
directed to do so with the ``COMPRESSION`` option. Valid values for
``<compression>`` are ``None``, ``BZip2``, ``GZip``, ``XZ``, and ``Zstd``.
+Compression level can be specied by using ``COMPRESSION_LEVEL`` option.
+Compression level should be between 0-9. 0 is the default compression.
+``COMPRESSION`` option must be specified for ``COMPRESSION_LEVEL``.
+
.. note::
With ``FORMAT`` set to ``raw`` only one file will be compressed with the
compression type specified by ``COMPRESSION``.
diff --git a/Help/release/dev/file-ARCHIVE-compression-level.rst b/Help/release/dev/file-ARCHIVE-compression-level.rst
new file mode 100644
index 0000000..719b694
--- /dev/null
+++ b/Help/release/dev/file-ARCHIVE-compression-level.rst
@@ -0,0 +1,5 @@
+file-ARCHIVE-compression-level
+------------------------------
+
+* The :command:`file(ARCHIVE_CREATE)` command gained a ``COMPRESSION_LEVEL``
+ option to specify the compression level.