summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorNils Gladitz <nilsgladitz@gmail.com>2014-11-26 22:22:24 (GMT)
committerBrad King <brad.king@kitware.com>2014-12-01 13:48:19 (GMT)
commit07254a8166f7f45d284b0982c59b185037d21bc1 (patch)
tree0a6cf7d23a525f2a5e2c9d2d54bd9b2133c9b3da /Help/command
parenta1aceb2585cb4b1e4e58ac32d9435ed43ad2d1d2 (diff)
downloadCMake-07254a8166f7f45d284b0982c59b185037d21bc1.zip
CMake-07254a8166f7f45d284b0982c59b185037d21bc1.tar.gz
CMake-07254a8166f7f45d284b0982c59b185037d21bc1.tar.bz2
Help: Document installed file property API
Since commit v3.1.0-rc1~479^2~1 (Add an "installed file" property scope, 2014-05-15) the get_property and set_property commands support an 'INSTALL' scope. Add documentation for this scope.
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/get_property.rst4
-rw-r--r--Help/command/set_property.rst17
2 files changed, 21 insertions, 0 deletions
diff --git a/Help/command/get_property.rst b/Help/command/get_property.rst
index abec8f9..632ece6 100644
--- a/Help/command/get_property.rst
+++ b/Help/command/get_property.rst
@@ -10,6 +10,7 @@ Get a property.
DIRECTORY [dir] |
TARGET <target> |
SOURCE <source> |
+ INSTALL <file> |
TEST <test> |
CACHE <entry> |
VARIABLE>
@@ -35,6 +36,9 @@ be one of the following:
``SOURCE``
Scope must name one source file.
+``INSTALL``
+ Scope must name one installed file path.
+
``TEST``
Scope must name one existing test.
diff --git a/Help/command/set_property.rst b/Help/command/set_property.rst
index 8c4f610..6200230 100644
--- a/Help/command/set_property.rst
+++ b/Help/command/set_property.rst
@@ -9,6 +9,7 @@ Set a named property in a given scope.
DIRECTORY [dir] |
TARGET [target1 [target2 ...]] |
SOURCE [src1 [src2 ...]] |
+ INSTALL [file1 [file2 ...]] |
TEST [test1 [test2 ...]] |
CACHE [entry1 [entry2 ...]]>
[APPEND] [APPEND_STRING]
@@ -34,6 +35,22 @@ be one of the following:
file properties are visible only to targets added in the same
directory (CMakeLists.txt).
+``INSTALL``
+ Scope may name zero or more installed file paths.
+ These are made available to CPack to influence deployment.
+
+ Both the property key and value may use generator expressions.
+ Specific properties may apply to installed files and/or directories.
+
+ Path components have to be separated by forward slashes,
+ must be normalized and are case sensitive.
+
+ To reference the installation prefix itself with a relative path use ".".
+
+ Currently installed file properties are only defined for
+ the WIX generator where the given paths are relative
+ to the installation prefix.
+
``TEST``
Scope may name zero or more existing tests.