kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.
This commit is contained in:
Nils Gladitz 2014-11-26 17:22:24 -05:00 committed by Brad King
parent a1aceb2585
commit 07254a8166
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Help/command/get_property.rst
View File

@ -10,6 +10,7 @@ Get a property.
DIRECTORY [dir] | DIRECTORY [dir] |
TARGET <target> | TARGET <target> |
SOURCE <source> | SOURCE <source> |
INSTALL <file> |
TEST <test> | TEST <test> |
CACHE <entry> | CACHE <entry> |
VARIABLE> VARIABLE>
@ -35,6 +36,9 @@ be one of the following:
``SOURCE`` ``SOURCE``
Scope must name one source file. Scope must name one source file.
``INSTALL``
Scope must name one installed file path.
``TEST`` ``TEST``
Scope must name one existing test. Scope must name one existing test.

17
Help/command/set_property.rst
View File

@ -9,6 +9,7 @@ Set a named property in a given scope.
DIRECTORY [dir] | DIRECTORY [dir] |
TARGET [target1 [target2 ...]] | TARGET [target1 [target2 ...]] |
SOURCE [src1 [src2 ...]] | SOURCE [src1 [src2 ...]] |
INSTALL [file1 [file2 ...]] |
TEST [test1 [test2 ...]] | TEST [test1 [test2 ...]] |
CACHE [entry1 [entry2 ...]]> CACHE [entry1 [entry2 ...]]>
[APPEND] [APPEND_STRING] [APPEND] [APPEND_STRING]
@ -34,6 +35,22 @@ be one of the following:
file properties are visible only to targets added in the same file properties are visible only to targets added in the same
directory (CMakeLists.txt). 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`` ``TEST``
Scope may name zero or more existing tests. Scope may name zero or more existing tests.