mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-06 13:51:33 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'doc-sections'

Browse Source 
22aac6669b Help: install: use bullet lists to sort out target kinds
b3f4d50348 Help: ifw.rst: Add toc; mv "Hints" section -> subsection of "Variables"
c671966c20 Help: CPackComponent: Sectioning and rewording
05e56b1897 Help: FetchContent, ExternalProject: Command sections -> subsections

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !4367
This commit is contained in:
Brad King
2020-02-18 16:26:05 +00:00
committed by Kitware Robot
parent 200e81ae1b 22aac6669b
commit 084c14d952
5 changed files with 116 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
Modules/CPackComponent.cmake
View File

@@ -7,25 +7,32 @@ CPackComponent
Configure components for binary installers and source packages.
Variables concerning CPack Components
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. only:: html
This module handles the component part of :module:`CPack`.
.. contents::
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
Introduction
^^^^^^^^^^^^
This module is automatically included by :module:`CPack`.
Certain binary installers (especially the graphical installers) generated
by CPack allow users to select individual application *components* to install.
This module allows developers to configure the packaging of such components.
Contents is assigned to components by the ``COMPONENT``
argument of CMake's :command:`install` command. 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,
for more information about component-specific installations.
resulting installer, using the commands described below.
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 :command:`install`,
and should be further described by the following CPack commands:
To specify different groupings for different CPack generators use
a CPACK_PROJECT_CONFIG_FILE.
Variables
^^^^^^^^^
The following variables influence the component-specific packaging:
.. variable:: CPACK_COMPONENTS_ALL
@@ -59,16 +66,14 @@ and should be further described by the following CPack commands:
Specify how components are grouped for multi-package component-aware CPack
generators.
Some generators like RPM or ARCHIVE family (TGZ, ZIP, ...) generates
several packages files when asked for component packaging. They group
the component differently depending on the value of this variable:
Some generators like RPM or ARCHIVE (TGZ, ZIP, ...) may generate
several packages files when there are components, depending
on the value of this variable:
* ONE_PER_GROUP (default): creates one package file per component group
* ALL_COMPONENTS_IN_ONE : creates a single package with all (requested) components
* IGNORE : creates one package per component, i.e. IGNORE component group
One can specify different grouping for different CPack generator by
using a CPACK_PROJECT_CONFIG_FILE.
* ONE_PER_GROUP (default): create one package per component group
* IGNORE : create one package per component (ignore the groups)
* ALL_COMPONENTS_IN_ONE : create a single package with all requested
components
.. variable:: CPACK_COMPONENT_<compName>_DISPLAY_NAME
@@ -98,10 +103,15 @@ and should be further described by the following CPack commands:
True if this component is not selected to be installed by default.
Commands
^^^^^^^^
Add component
"""""""""""""
.. command:: cpack_add_component
Describes a CPack installation
component named by the COMPONENT argument to a CMake INSTALL command.
Describe an installation component.
::
@@ -116,13 +126,11 @@ component named by the COMPONENT argument to a CMake INSTALL command.
[ARCHIVE_FILE filename]
[PLIST filename])
The cmake_add_component command describes an installation component,
which the user can opt to install or remove as part of the graphical
installation process. compname is the name of the component, as
provided to the COMPONENT argument of one or more CMake INSTALL
commands.
``compname`` is the name of an installation component, as defined by the
``COMPONENT`` argument of one or more CMake :command:`install` commands.
With the ``cpack_add_component`` command one can set a name, a description,
and other attributes of an installation component.
One can also assign a component to a component group.
DISPLAY_NAME is the displayed name of the component, used in graphical
installers to display the component name. This value can be any
@@ -175,6 +183,9 @@ the component. See cpack_configure_downloads for more information.
PLIST gives a filename that is passed to pkgbuild with the
``--component-plist`` argument when using the productbuild generator.
Add component group
"""""""""""""""""""
.. command:: cpack_add_component_group
Describes a group of related CPack installation components.
@@ -223,6 +234,9 @@ single entry.
BOLD_TITLE indicates that the group title should appear in bold, to
call the user's attention to the group.
Add installation type
"""""""""""""""""""""
.. command:: cpack_add_install_type
Add a new installation type containing
@@ -247,6 +261,9 @@ DISPLAY_NAME is the displayed name of the install type, which will
typically show up in a drop-down box within a graphical installer.
This value can be any string.
Configure downloads
"""""""""""""""""""
.. command:: cpack_configure_downloads
Configure CPack to download
@@ -279,8 +296,6 @@ requires the ZipDLL plug-in for NSIS, available at:
http://nsis.sourceforge.net/ZipDLL_plug-in
On macOS, installers that download components on-the-fly can only
be built and installed on system using macOS 10.5 or later.

9
Modules/ExternalProject.cmake
View File

@@ -9,8 +9,11 @@ ExternalProject
.. contents::
Commands
^^^^^^^^
External Project Definition
^^^^^^^^^^^^^^^^^^^^^^^^^^^
"""""""""""""""""""""""""""
.. command:: ExternalProject_Add
@@ -665,7 +668,7 @@ External Project Definition
automatic substitutions that are supported for some options.
Obtaining Project Properties
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
""""""""""""""""""""""""""""
.. command:: ExternalProject_Get_Property
@@ -686,7 +689,7 @@ Obtaining Project Properties
message("Source dir of myExtProj = ${SOURCE_DIR}")
Explicit Step Management
^^^^^^^^^^^^^^^^^^^^^^^^
""""""""""""""""""""""""
The ``ExternalProject_Add()`` function on its own is often sufficient for
incorporating an external project into the main build. Certain scenarios

7
Modules/FetchContent.cmake
View File

@@ -76,8 +76,11 @@ sometimes useful as part of implementing some higher level feature or to
populate some content in CMake's script mode.
Commands
^^^^^^^^
Declaring Content Details
^^^^^^^^^^^^^^^^^^^^^^^^^
"""""""""""""""""""""""""
.. command:: FetchContent_Declare
@@ -130,7 +133,7 @@ Declaring Content Details
)
Populating The Content
^^^^^^^^^^^^^^^^^^^^^^
""""""""""""""""""""""
For most common scenarios, population means making content available to the
main build according to previously declared details for that dependency.