summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoachim Wuttke (o) <j.wuttke@fz-juelich.de>2020-02-12 12:23:08 (GMT)
committerJoachim Wuttke (o) <j.wuttke@fz-juelich.de>2020-02-12 12:23:08 (GMT)
commit4949e1261a7b81f8627b6edd961513b08d667991 (patch)
tree2073656920f2f92044fee250bc4cf22a42a4c77e
parent72eaeb41f5c0ba7dd4a3a4fa562fcd057fb68332 (diff)
downloadCMake-4949e1261a7b81f8627b6edd961513b08d667991.zip
CMake-4949e1261a7b81f8627b6edd961513b08d667991.tar.gz
CMake-4949e1261a7b81f8627b6edd961513b08d667991.tar.bz2
Help: module CPack. Explain usage of the build targets.
Explain the usage of the two new build targets, package and package_source.
-rw-r--r--Modules/CPack.cmake18
1 files changed, 11 insertions, 7 deletions
diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake
index 84493f6..f998abf 100644
--- a/Modules/CPack.cmake
+++ b/Modules/CPack.cmake
@@ -15,13 +15,17 @@ and ``CPackSourceConfig.cmake``. They are intended for use in a subsequent
run of the :manual:`cpack <cpack(1)>` program where they steer the generation
of installers or/and source packages.
-Inclusion of the CPack module adds two new build targets, ``package``
-and ``package_source``, which build the binary and source installers
-respectively. 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`).
-
+The CPack module also adds two new build targets, ``package`` and
+``package_source``. This makes it possible to build a binary installer
+from CMake, Make, or Ninja: Instead of ``cpack``, call ``cmake --build .
+--target package`` or ``make package`` or ``ninja package``. Similary, to build
+a source package, instead of ``cpack -G TGZ --config CPackConfig.cmake``,
+call ``cmake --build . --target package_source``, ``make package_source``,
+or ``ninja package_source``.
+
+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.