summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2018-04-30 13:24:59 (GMT)
committerKitware Robot <kwrobot@kitware.com>2018-04-30 13:25:08 (GMT)
commitf6c558e3156129967203164fc8450eba58e80739 (patch)
tree5e1ec74c2382e98283649ed73ffa8026fb2a9446 /Modules
parent9b19d922c83e567dc3a9309821b8cb5f894c554e (diff)
parent9a8687121f9be08e569476b485434aa9aa3fec88 (diff)
downloadCMake-f6c558e3156129967203164fc8450eba58e80739.zip
CMake-f6c558e3156129967203164fc8450eba58e80739.tar.gz
CMake-f6c558e3156129967203164fc8450eba58e80739.tar.bz2
Merge topic 'cpack_docs_cleanup'
9a8687121f Help: Improve accuracy, readability and cross-referencing of cpack docs Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2013
Diffstat (limited to 'Modules')
-rw-r--r--Modules/CPack.cmake15
1 files changed, 7 insertions, 8 deletions
diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake
index 3ff8be6..a71f84a 100644
--- a/Modules/CPack.cmake
+++ b/Modules/CPack.cmake
@@ -43,9 +43,9 @@
#
# * cpack runs
# * it includes CPackConfig.cmake
-# * it iterates over the generators listed in that file's
-# CPACK_GENERATOR list variable (unless told to use just a
-# specific one via -G on the command line...)
+# * it iterates over the generators given by the ``-G`` command line option,
+# or if no such option was specified, over the list of generators given by
+# the CPACK_GENERATOR variable set in the CPackConfig.cmake input file.
# * foreach generator, it then
#
# - sets CPACK_GENERATOR to the one currently being iterated
@@ -182,12 +182,11 @@
#
# .. variable:: CPACK_GENERATOR
#
-# List of CPack generators to use. If not specified, CPack will create a
+# List of CPack generators to use. If not specified, CPack will create a
# set of options CPACK_BINARY_<GENNAME> (e.g., CPACK_BINARY_NSIS) allowing
-# the user to enable/disable individual generators. This variable may be
-# used on the command line as well as in::
-#
-# cpack -D CPACK_GENERATOR="ZIP;TGZ" /path/to/build/tree
+# the user to enable/disable individual generators. If the ``-G`` option
+# is given on the :manual:`cpack <cpack(1)>` command line, it will override
+# this variable and any CPACK_BINARY_<GENNAME> options.
#
# .. variable:: CPACK_OUTPUT_CONFIG_FILE
#