mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-02-22 06:59:01 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: module CPack: improve summary and Introduction

Browse Source 
* 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
This commit is contained in:
Joachim Wuttke (o)
2020-02-12 16:15:26 +01:00
committed by Craig Scott
parent 5c4d730dd4
commit 0ea52ece71
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
Modules/CPack.cmake
View File

@@ -5,7 +5,7 @@
CPack CPack
----- -----
Configure the binary and source package installers. Configure generators for binary installers and source packages.
Introduction 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`_ targets, ``package`` and ``package_source``. See the `packaging targets`_
section below for details. section below for details.
The generated binary installers contain everything installed via CMake's The generated binary installers will contain all files that have been installed
:command:`install` command (and the deprecated commands :command:`install_files`, via CMake's :command:`install` command (and the deprecated commands
:command:`install_programs`, and :command:`install_targets`). :command:`install_files`, :command:`install_programs`, and
For certain kinds of binary installers (including the graphical :command:`install_targets`). Certain kinds of binary installers can be
installers on macOS and Windows), CPack generates installers that configured such that users can select individual application components to
allow users to select individual application components to install. install. See the :module:`CPackComponent` module for further details.
See :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 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 :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 per-cpack-generator logic to control *other* cpack settings, then you
need a :variable:`CPACK_PROJECT_CONFIG_FILE`. 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 If set, the :variable:`CPACK_PROJECT_CONFIG_FILE` is included automatically
on a per-generator basis. It only need contain overrides. on a per-generator basis. It only need contain overrides.