Help: CPackComponent: improve summary and introduction

Also:
* provide some hyperlinks
* update parenthesis on graphical installers (no longer restricted
  to Win and macOS)
This commit is contained in:
Joachim Wuttke (o)
2020-02-12 16:52:23 +01:00
committed by Craig Scott
parent 40da958d23
commit 5c4d730dd4

View File

@@ -5,19 +5,18 @@
CPackComponent CPackComponent
-------------- --------------
Build binary and source package installers Configure components for binary installers and source packages.
Variables concerning CPack Components Variables concerning CPack Components
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The CPackComponent module is the module which handles the component This module handles the component part of :module:`CPack`.
part of CPack. See CPack module for general information about CPack.
For certain kinds of binary installers (including the graphical For certain kinds of binary installers (especially the graphical installers),
installers on macOS and Windows), CPack generates installers that CPack generates installers that allow users to select individual application
allow users to select individual application components to install. components to install.
The contents of each of the components are identified by the COMPONENT The contents of each of the components are identified by the ``COMPONENT``
argument of CMake's INSTALL command. These components can be argument of CMake's :command:`install` command. These components can be
annotated with user-friendly names and descriptions, inter-component annotated with user-friendly names and descriptions, inter-component
dependencies, etc., and grouped in various ways to customize the dependencies, etc., and grouped in various ways to customize the
resulting installer. See the cpack_add_* commands, described below, 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 Component-specific installation allows users to select specific sets
of components to install during the install process. Installation of components to install during the install process. Installation
components are identified by the COMPONENT argument of CMake's INSTALL components are identified by the ``COMPONENT`` argument of :command:`install`,
commands, and should be further described by the following CPack and should be further described by the following CPack commands:
commands:
.. variable:: CPACK_COMPONENTS_ALL .. variable:: CPACK_COMPONENTS_ALL