Merge topic 'doc-install-component-association'

d7c6b710 Merge branch 'backport-doc-install-component-association' into doc-install-component-association
c978223c Help: Clarify install(TARGETS) INCLUDES DESTINATION option
70f2708f Help: Clarify install(TARGETS) INCLUDES DESTINATION option
This commit is contained in:
Brad King 2016-02-18 10:08:06 -05:00 committed by CMake Topic Stage
commit 937f7fdd91
1 changed files with 12 additions and 7 deletions

View File

@ -76,13 +76,14 @@ Installing Targets
[[ARCHIVE|LIBRARY|RUNTIME|FRAMEWORK|BUNDLE| [[ARCHIVE|LIBRARY|RUNTIME|FRAMEWORK|BUNDLE|
PRIVATE_HEADER|PUBLIC_HEADER|RESOURCE] PRIVATE_HEADER|PUBLIC_HEADER|RESOURCE]
[DESTINATION <dir>] [DESTINATION <dir>]
[INCLUDES DESTINATION [<dir> ...]]
[PERMISSIONS permissions...] [PERMISSIONS permissions...]
[CONFIGURATIONS [Debug|Release|...]] [CONFIGURATIONS [Debug|Release|...]]
[COMPONENT <component>] [COMPONENT <component>]
[OPTIONAL] [EXCLUDE_FROM_ALL] [OPTIONAL] [EXCLUDE_FROM_ALL]
[NAMELINK_ONLY|NAMELINK_SKIP] [NAMELINK_ONLY|NAMELINK_SKIP]
] [...]) ] [...]
[INCLUDES DESTINATION [<dir> ...]]
)
The ``TARGETS`` form specifies rules for installing targets from a The ``TARGETS`` form specifies rules for installing targets from a
project. There are five kinds of target files that may be installed: project. There are five kinds of target files that may be installed:
@ -102,11 +103,7 @@ change the type of target to which the subsequent properties apply.
If none is given the installation properties apply to all target If none is given the installation properties apply to all target
types. If only one is given then only targets of that type will be types. If only one is given then only targets of that type will be
installed (which can be used to install just a DLL or just an import installed (which can be used to install just a DLL or just an import
library). The ``INCLUDES DESTINATION`` specifies a list of directories library).
which will be added to the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES`
target property of the ``<targets>`` when exported by the
:command:`install(EXPORT)` command. If a relative path is
specified, it is treated as relative to the ``$<INSTALL_PREFIX>``.
The ``PRIVATE_HEADER``, ``PUBLIC_HEADER``, and ``RESOURCE`` arguments The ``PRIVATE_HEADER``, ``PUBLIC_HEADER``, and ``RESOURCE`` arguments
cause subsequent properties to be applied to installing a ``FRAMEWORK`` cause subsequent properties to be applied to installing a ``FRAMEWORK``
@ -136,6 +133,14 @@ option installs nothing. See the :prop_tgt:`VERSION` and
:prop_tgt:`SOVERSION` target properties for details on creating versioned :prop_tgt:`SOVERSION` target properties for details on creating versioned
shared libraries. shared libraries.
The ``INCLUDES DESTINATION`` specifies a list of directories
which will be added to the :prop_tgt:`INTERFACE_INCLUDE_DIRECTORIES`
target property of the ``<targets>`` when exported by the
:command:`install(EXPORT)` command. If a relative path is
specified, it is treated as relative to the ``$<INSTALL_PREFIX>``.
This is independent of the rest of the argument groups and does
not actually install anything.
One or more groups of properties may be specified in a single call to One or more groups of properties may be specified in a single call to
the ``TARGETS`` form of this command. A target may be installed more than the ``TARGETS`` form of this command. A target may be installed more than
once to different locations. Consider hypothetical targets ``myExe``, once to different locations. Consider hypothetical targets ``myExe``,