summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2016-02-18 15:08:06 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2016-02-18 15:08:06 (GMT)
commit937f7fdd914e4b368c9ace82b30e72cd66c5b866 (patch)
tree3d4297a91822e8c37e76eae7da248f0e1782c834 /Help
parente503941adb1f9c5d2a61e62b2b06003e959f28dd (diff)
parentd7c6b7103b3e247224dfb5b09959f9d2c8cc1898 (diff)
downloadCMake-937f7fdd914e4b368c9ace82b30e72cd66c5b866.zip
CMake-937f7fdd914e4b368c9ace82b30e72cd66c5b866.tar.gz
CMake-937f7fdd914e4b368c9ace82b30e72cd66c5b866.tar.bz2
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
Diffstat (limited to 'Help')
-rw-r--r--Help/command/install.rst19
1 files changed, 12 insertions, 7 deletions
diff --git a/Help/command/install.rst b/Help/command/install.rst
index 189b51c..aaf12cc 100644
--- a/Help/command/install.rst
+++ b/Help/command/install.rst
@@ -76,13 +76,14 @@ Installing Targets
[[ARCHIVE|LIBRARY|RUNTIME|FRAMEWORK|BUNDLE|
PRIVATE_HEADER|PUBLIC_HEADER|RESOURCE]
[DESTINATION <dir>]
- [INCLUDES DESTINATION [<dir> ...]]
[PERMISSIONS permissions...]
[CONFIGURATIONS [Debug|Release|...]]
[COMPONENT <component>]
[OPTIONAL] [EXCLUDE_FROM_ALL]
[NAMELINK_ONLY|NAMELINK_SKIP]
- ] [...])
+ ] [...]
+ [INCLUDES DESTINATION [<dir> ...]]
+ )
The ``TARGETS`` form specifies rules for installing targets from a
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
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
-library). 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>``.
+library).
The ``PRIVATE_HEADER``, ``PUBLIC_HEADER``, and ``RESOURCE`` arguments
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
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
the ``TARGETS`` form of this command. A target may be installed more than
once to different locations. Consider hypothetical targets ``myExe``,