summaryrefslogtreecommitdiff
path: root/Modules/CPack.cmake
diff options
context:
space:
mode:
authorJoachim Wuttke (h) <j.wuttke@fz-juelich.de>2018-11-11 23:02:55 +0100
committerBrad King <brad.king@kitware.com>2018-11-12 09:18:02 -0500
commite286627334b08b524d228beccd818ebc4a10f799 (patch)
tree695e4a8ace0f894afafc997d3dedbb4ea93372c4 /Modules/CPack.cmake
parent206ce3c0ba730f34444a8627d6a4f261bf60fc92 (diff)
downloadcmake-e286627334b08b524d228beccd818ebc4a10f799.tar.gz
Help: Insert section headers in CPack module
The one extant section header was confusing at least: Not all the doc page is on Variables.
Diffstat (limited to 'Modules/CPack.cmake')
-rw-r--r--Modules/CPack.cmake10
1 files changed, 8 insertions, 2 deletions
diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake
index f3e34233a1..ebce85136f 100644
--- a/Modules/CPack.cmake
+++ b/Modules/CPack.cmake
@@ -7,8 +7,8 @@ CPack
Build binary and source package installers.
-Variables common to all CPack generators
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Introduction
+^^^^^^^^^^^^
The CPack module generates binary and source installers in a variety of
formats using the cpack program. Inclusion of the CPack module adds
@@ -23,6 +23,9 @@ 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.
+CPack generators
+^^^^^^^^^^^^^^^^
+
The :variable:`CPACK_GENERATOR` variable has different meanings in different
contexts. In a ``CMakeLists.txt`` file, :variable:`CPACK_GENERATOR` is a
*list of generators*: and when :manual:`cpack <cpack(1)>` is run with no other
@@ -57,6 +60,9 @@ This is the key: For each generator listed in :variable:`CPACK_GENERATOR` in
internally to *the one currently being used* and then include the
:variable:`CPACK_PROJECT_CONFIG_FILE`.
+Variables common to all CPack generators
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
Before including this CPack module in your ``CMakeLists.txt`` file, there
are a variety of variables that can be set to customize the resulting
installers. The most commonly-used variables are: