diff options
| author | Brad King <brad.king@kitware.com> | 2020-06-29 12:23:14 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2020-06-29 12:23:20 (GMT) |
| commit | e23428c99f146699dbcc724c45837cd61bc13ae7 (patch) | |
| tree | 89ed0c611cb084482526a7e9fb181bce1ffadb80 /Help | |
| parent | 4c28bf2acacec2de4db1465d330a410d771134d5 (diff) | |
| parent | 95159b7dea20c65e3c1d9b112cd4c5f4646b6a97 (diff) | |
| download | CMake-e23428c99f146699dbcc724c45837cd61bc13ae7.zip CMake-e23428c99f146699dbcc724c45837cd61bc13ae7.tar.gz CMake-e23428c99f146699dbcc724c45837cd61bc13ae7.tar.bz2 | |
Merge topic 'file-ARCHIVE_CREATE-rename-TYPE-option' into release-3.18
95159b7dea file(ARCHIVE_CREATE): Rename TYPE option to COMPRESSION
bc45bdc819 Help: Fix contents indenting for file(ARCHIVE_...) subcommands
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4948
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/file.rst | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/Help/command/file.rst b/Help/command/file.rst index bb560a9..b109f9d 100644 --- a/Help/command/file.rst +++ b/Help/command/file.rst @@ -42,9 +42,9 @@ Synopsis `Locking`_ file(`LOCK`_ <path> [...]) - `Archiving`_ - file(`ARCHIVE_CREATE`_ OUTPUT <archive> FILES <files> [...]) - file(`ARCHIVE_EXTRACT`_ INPUT <archive> DESTINATION <dir> [...]) + `Archiving`_ + file(`ARCHIVE_CREATE`_ OUTPUT <archive> FILES <files> [...]) + file(`ARCHIVE_EXTRACT`_ INPUT <archive> DESTINATION <dir> [...]) Reading ^^^^^^^ @@ -903,28 +903,30 @@ Archiving [FILES <files>] [DIRECTORY <dirs>] [FORMAT <format>] - [TYPE <type>] + [COMPRESSION <compression>] [MTIME <mtime>] [VERBOSE]) -Creates an archive specifed by ``OUTPUT`` with the content of ``FILES`` and -``DIRECTORY``. +Creates the specified ``<archive>`` file with the content of ``<files>`` and +``<dirs>``. -To specify the format of the archive set the ``FORMAT`` option. -Supported formats are: ``7zip``, ``gnutar``, ``pax``, ``paxr``, ``raw``, -(restricted pax, default), and ``zip``. +Use the ``FORMAT`` option to specify the archive format. Supported values +for ``<format>`` are ``7zip``, ``gnutar``, ``pax``, ``paxr``, ``raw`` and +``zip``. If ``FORMAT`` is not given, the default format is ``paxr``. -To specify the type of compression set the ``TYPE`` option. -Supported compression types are: ``None``, ``BZip2``, ``GZip``, ``XZ``, -and ``Zstd``. +Some archive formats allow the type of compression to be specified. +The ``7zip`` and ``zip`` archive formats already imply a specific type of +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``. .. note:: With ``FORMAT`` set to ``raw`` only one file will be compressed with the - compression type specified by ``TYPE``. + compression type specified by ``COMPRESSION``. -With ``VERBOSE`` the command will produce verbose output. +The ``VERBOSE`` option enables verbose output for the archive operation. -To specify the modification time recorded in tarball entries use +To specify the modification time recorded in tarball entries, use the ``MTIME`` option. .. _ARCHIVE_EXTRACT: |