diff options
| author | Craig Scott <craig.scott@crascit.com> | 2020-02-15 21:22:35 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2020-02-15 21:22:45 (GMT) |
| commit | c76a719ab18e9131e62ace634e639fbf166a68f8 (patch) | |
| tree | d5636ed6b2313660a1a5d3a88e40edae654b23be /Help | |
| parent | 8be99c62eac63ffd8e020f325a7d15a74c73ba18 (diff) | |
| parent | 0ea52ece71d3e952ec5158caa87ecf84582ea4ca (diff) | |
| download | CMake-c76a719ab18e9131e62ace634e639fbf166a68f8.zip CMake-c76a719ab18e9131e62ace634e639fbf166a68f8.tar.gz CMake-c76a719ab18e9131e62ace634e639fbf166a68f8.tar.bz2 | |
Merge topic 'doc-cpack'
0ea52ece71 Help: module CPack: improve summary and Introduction
5c4d730dd4 Help: CPackComponent: improve summary and introduction
40da958d23 Help: CPack Archive Generator: Clarify source vs binary package
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4354
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/cpack_gen/archive.rst | 47 |
1 files changed, 32 insertions, 15 deletions
diff --git a/Help/cpack_gen/archive.rst b/Help/cpack_gen/archive.rst index d455f4b..052f9cf 100644 --- a/Help/cpack_gen/archive.rst +++ b/Help/cpack_gen/archive.rst @@ -1,8 +1,8 @@ CPack Archive Generator ----------------------- -Archive CPack generator that supports packaging of sources and binaries in -different formats: +CPack generator for packaging files into an archive, which can have +any of the following formats: - 7Z - 7zip - (.7z) - TBZ2 (.tar.bz2) @@ -12,25 +12,42 @@ different formats: - TZST (.tar.zst) - ZIP (.zip) +When this generator is called from ``CPackSourceConfig.cmake`` (or through +the ``package_source`` target), then the generated archive will contain all +files in the project directory, except those specified in +:variable:`CPACK_SOURCE_IGNORE_FILES`. The following is one example of +packaging all source files of a project: + +.. code-block:: cmake + + set(CPACK_SOURCE_GENERATOR "TGZ") + set(CPACK_SOURCE_IGNORE_FILES + \\.git/ + build/ + ".*~$" + ) + set(CPACK_VERBATIM_VARIABLES YES) + include(CPack) + +When this is generator is called from ``CPackConfig.cmake`` (or through the +``package`` target), then the generated archive will contain all files +that have been installed via CMake's :command:`install` command (and the +deprecated commands :command:`install_files`, :command:`install_programs`, +and :command:`install_targets`). + Variables specific to CPack Archive generator ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. variable:: CPACK_ARCHIVE_FILE_NAME CPACK_ARCHIVE_<component>_FILE_NAME - Package file name without extension which is added automatically depending - on the archive format. - - * Mandatory : YES - * Default : ``<CPACK_PACKAGE_FILE_NAME>[-<component>].<extension>`` with - spaces replaced by '-' + Package file name without extension. The extension is determined from the + archive format (see list above) and automatically appended to the file name. + The default is ``<CPACK_PACKAGE_FILE_NAME>[-<component>]``, with spaces + replaced by '-'. .. variable:: CPACK_ARCHIVE_COMPONENT_INSTALL - Enable component packaging for CPackArchive - - * Mandatory : NO - * Default : OFF - - If enabled (ON) multiple packages are generated. By default a single package - containing files of all components is generated. + 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. |