diff options
| author | Craig Scott <craig.scott@crascit.com> | 2018-04-27 05:23:22 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2018-04-27 23:31:42 (GMT) |
| commit | 9a8687121f9be08e569476b485434aa9aa3fec88 (patch) | |
| tree | 85f6391e3327e8715fbe19884091af709a7b93b2 /Modules/CPack.cmake | |
| parent | 48dcb2cacb3f20b1ad16899340c1c0e8ec6048c8 (diff) | |
| download | CMake-9a8687121f9be08e569476b485434aa9aa3fec88.zip CMake-9a8687121f9be08e569476b485434aa9aa3fec88.tar.gz CMake-9a8687121f9be08e569476b485434aa9aa3fec88.tar.bz2 | |
Help: Improve accuracy, readability and cross-referencing of cpack docs
This is primarily a cleanup of the cpack(1) page. The cpack.cxx file
and CPack module were also updated to make the docs relating to
the generator specification and option names consistent in all
three places.
Diffstat (limited to 'Modules/CPack.cmake')
| -rw-r--r-- | Modules/CPack.cmake | 15 |
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 # |