diff options
| author | Joachim Wuttke (o) <j.wuttke@fz-juelich.de> | 2020-02-12 15:15:26 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2020-02-14 10:49:47 (GMT) |
| commit | 0ea52ece71d3e952ec5158caa87ecf84582ea4ca (patch) | |
| tree | c9cc8b30582a6b2b0c3dbaa7e4e687f69a1e01ea /Modules/CPack.cmake | |
| parent | 5c4d730dd4a4ebfc4d4fd549c28e08821e1bc573 (diff) | |
| download | CMake-0ea52ece71d3e952ec5158caa87ecf84582ea4ca.zip CMake-0ea52ece71d3e952ec5158caa87ecf84582ea4ca.tar.gz CMake-0ea52ece71d3e952ec5158caa87ecf84582ea4ca.tar.bz2 | |
Help: module CPack: improve summary and Introduction
* In summary:
* we configure generators, not the generated installers
* we generate installers or source packages, not source package installers
* In Introduction:
* Make paragraph on binary installers more concise
* Remove example that refered to CMake source tree
* Add paragraph on source packages
* omit the parenthesis on graphical installers
Diffstat (limited to 'Modules/CPack.cmake')
| -rw-r--r-- | Modules/CPack.cmake | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake index baf7e47..6234b9d 100644 --- a/Modules/CPack.cmake +++ b/Modules/CPack.cmake @@ -5,7 +5,7 @@ CPack ----- -Configure the binary and source package installers. +Configure generators for binary installers and source packages. Introduction ^^^^^^^^^^^^ @@ -19,13 +19,17 @@ Depending on the CMake generator, the CPack module may also add two new build targets, ``package`` and ``package_source``. See the `packaging targets`_ section below for details. -The generated binary installers contain everything installed via CMake's -:command:`install` command (and the deprecated commands :command:`install_files`, -:command:`install_programs`, and :command:`install_targets`). -For certain kinds of binary installers (including the graphical -installers on macOS and Windows), CPack generates installers that -allow users to select individual application components to install. -See :module:`CPackComponent` module for further details. +The generated binary installers 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`). Certain kinds of binary installers can be +configured such that users can select individual application components to +install. See the :module:`CPackComponent` module for further details. + +Source packages (configured through ``CPackSourceConfig.cmake`` and generated +by the :cpack_gen:`CPack Archive Generator`) will contain all source files in +the project directory except those specified in +:variable:`CPACK_SOURCE_IGNORE_FILES`. CPack Generators ^^^^^^^^^^^^^^^^ @@ -38,10 +42,6 @@ generator. In a :variable:`CPACK_PROJECT_CONFIG_FILE`, :variable:`CPACK_GENERATOR` is a *string naming a single generator*. If you need per-cpack-generator logic to control *other* cpack settings, then you need a :variable:`CPACK_PROJECT_CONFIG_FILE`. - -The CMake source tree itself contains a :variable:`CPACK_PROJECT_CONFIG_FILE`. -See the top level file ``CMakeCPackOptions.cmake.in`` for an example. - If set, the :variable:`CPACK_PROJECT_CONFIG_FILE` is included automatically on a per-generator basis. It only need contain overrides. |