diff options
| author | Kyle Edwards <kyle.edwards@kitware.com> | 2018-06-15 17:20:45 (GMT) |
|---|---|---|
| committer | Kyle Edwards <kyle.edwards@kitware.com> | 2018-06-21 15:00:25 (GMT) |
| commit | 2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a (patch) | |
| tree | dd2d8494ccbec274bb06d698f975cf7563d722e9 /Help/cpack_gen/archive.rst | |
| parent | be6267808a6b02c4125054d2fbcb81651b63e9aa (diff) | |
| download | CMake-2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a.zip CMake-2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a.tar.gz CMake-2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a.tar.bz2 | |
Help: Add new section for CPack generators
The documentation for CPack generators previously lived in their
respective internal CMake modules. This setup was misleading,
because it implied that you should include the modules in your own
code, which is not the case. Moving the documentation into a
separate section does a better job of hiding the internal modules,
which are just an implementation detail. The generator documentation
has also been modified to remove any references to the module name.
The CPackIFW module is a special exception: since it has user-facing
macros, the documentation for these macros has been kept in the module
page, while all other documentation related to the IFW generator has
been moved into the new section.
To make it easier to find the new documentation, the old help pages
for the CPack*.cmake modules have not been deleted, but have been
replaced with a link to their respective help page in the new
documentation section.
Diffstat (limited to 'Help/cpack_gen/archive.rst')
| -rw-r--r-- | Help/cpack_gen/archive.rst | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/Help/cpack_gen/archive.rst b/Help/cpack_gen/archive.rst new file mode 100644 index 0000000..b288aad --- /dev/null +++ b/Help/cpack_gen/archive.rst @@ -0,0 +1,35 @@ +CPack Archive Generator +----------------------- + +Archive CPack generator that supports packaging of sources and binaries in +different formats: + + - 7Z - 7zip - (.7z) + - TBZ2 (.tar.bz2) + - TGZ (.tar.gz) + - TXZ (.tar.xz) + - TZ (.tar.Z) + - ZIP (.zip) + +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 '-' + +.. 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. |