mirror of
https://github.com/reactos/CMake.git
synced 2024-12-06 10:46:42 +00:00
2a2829cc75
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.
36 lines
930 B
ReStructuredText
36 lines
930 B
ReStructuredText
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.
|