summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2018-01-08 16:55:32 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2018-01-08 20:07:30 (GMT)
commitf09fda97d88094d56d0f8f40fa361b920feccd46 (patch)
treea2a65b83a706a1a972b2f6d29b8a76edbbf8af81
parentf7f34a46e674fcf0326b0dbbc6dbb35c9e3c022f (diff)
downloadCMake-f09fda97d88094d56d0f8f40fa361b920feccd46.zip
CMake-f09fda97d88094d56d0f8f40fa361b920feccd46.tar.gz
CMake-f09fda97d88094d56d0f8f40fa361b920feccd46.tar.bz2
Help: improve install() documentation of argument ordering
Fixes #16362.
-rw-r--r--Help/command/install.rst16
1 files changed, 15 insertions, 1 deletions
diff --git a/Help/command/install.rst b/Help/command/install.rst
index f43b2a0..2506f98 100644
--- a/Help/command/install.rst
+++ b/Help/command/install.rst
@@ -38,7 +38,21 @@ signatures that specify them. The common options are:
``CONFIGURATIONS``
Specify a list of build configurations for which the install rule
- applies (Debug, Release, etc.).
+ applies (Debug, Release, etc.). Note that the values specified for
+ this option only apply to options listed AFTER the ``CONFIGURATIONS``
+ option. For example, to set separate install paths for the Debug and
+ Release configurations, do the following:
+
+ .. code-block:: cmake
+
+ install(TARGETS target
+ CONFIGURATIONS Debug
+ RUNTIME DESTINATION Debug/bin)
+ install(TARGETS target
+ CONFIGURATIONS Release
+ RUNTIME DESTINATION Release/bin)
+
+ Note that ``CONFIGURATIONS`` appears BEFORE ``RUNTIME DESTINATION``.
``COMPONENT``
Specify an installation component name with which the install rule