diff options
| author | Joachim Wuttke (o) <j.wuttke@fz-juelich.de> | 2020-02-12 16:52:23 +0100 |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2020-02-14 21:49:22 +1100 |
| commit | 5c4d730dd4a4ebfc4d4fd549c28e08821e1bc573 (patch) | |
| tree | 9d24bf180c46369a9312b241e79024ce311a4ca9 /Modules/CPackComponent.cmake | |
| parent | 40da958d235a7efc15607436d8ce6fdaee274342 (diff) | |
| download | cmake-5c4d730dd4a4ebfc4d4fd549c28e08821e1bc573.tar.gz | |
Help: CPackComponent: improve summary and introduction
Also:
* provide some hyperlinks
* update parenthesis on graphical installers (no longer restricted
to Win and macOS)
Diffstat (limited to 'Modules/CPackComponent.cmake')
| -rw-r--r-- | Modules/CPackComponent.cmake | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/Modules/CPackComponent.cmake b/Modules/CPackComponent.cmake index 211d7673c9..22fa6bb420 100644 --- a/Modules/CPackComponent.cmake +++ b/Modules/CPackComponent.cmake @@ -5,19 +5,18 @@ CPackComponent -------------- -Build binary and source package installers +Configure components for binary installers and source packages. Variables concerning CPack Components ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The CPackComponent module is the module which handles the component -part of CPack. See CPack module for general information about CPack. +This module handles the component part of :module:`CPack`. -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. -The contents of each of the components are identified by the COMPONENT -argument of CMake's INSTALL command. These components can be +For certain kinds of binary installers (especially the graphical installers), +CPack generates installers that allow users to select individual application +components to install. +The contents of each of the components are identified by the ``COMPONENT`` +argument of CMake's :command:`install` command. These components can be annotated with user-friendly names and descriptions, inter-component dependencies, etc., and grouped in various ways to customize the resulting installer. See the cpack_add_* commands, described below, @@ -25,9 +24,8 @@ for more information about component-specific installations. Component-specific installation allows users to select specific sets of components to install during the install process. Installation -components are identified by the COMPONENT argument of CMake's INSTALL -commands, and should be further described by the following CPack -commands: +components are identified by the ``COMPONENT`` argument of :command:`install`, +and should be further described by the following CPack commands: .. variable:: CPACK_COMPONENTS_ALL |