"Fossies" - the Fresh Open Source Software Archive

Member "cmake-3.14.5/Help/command/set_property.rst" (31 May 2019, 2936 Bytes) of package /linux/misc/cmake-3.14.5.tar.gz:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the last Fossies "Diffs" side-by-side code changes report for "set_property.rst": 3.14.5_vs_3.15.0-rc1.


Set a named property in a given scope.

set_property(<GLOBAL                      |
              DIRECTORY [<dir>]           |
              TARGET    [<target1> ...]   |
              SOURCE    [<src1> ...]      |
              INSTALL   [<file1> ...]     |
              TEST      [<test1> ...]     |
              CACHE     [<entry1> ...]    >
             [APPEND] [APPEND_STRING]
             PROPERTY <name> [value1 ...])

Sets one property on zero or more objects of a scope.

The first argument determines the scope in which the property is set. It must be one of the following:


Scope is unique and does not accept a name.


Scope defaults to the current directory but another directory (already processed by CMake) may be named by full or relative path. See also the set_directory_properties command.


Scope may name zero or more existing targets. See also the set_target_properties command.


Scope may name zero or more source files. Note that source file properties are visible only to targets added in the same directory (CMakeLists.txt). See also the set_source_files_properties command.


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.


Scope may name zero or more existing tests. See also the set_tests_properties command.


Scope must name zero or more cache existing entries.

The required PROPERTY option is immediately followed by the name of the property to set. Remaining arguments are used to compose the property value in the form of a semicolon-separated list.

If the APPEND option is given the list is appended to any existing property value. If the APPEND_STRING option is given the string is appended to any existing property value as string, i.e. it results in a longer string and not a list of strings. When using APPEND or APPEND_STRING with a property defined to support INHERITED behavior (see define_property), no inheriting occurs when finding the initial value to append to. If the property is not already directly set in the nominated scope, the command will behave as though APPEND or APPEND_STRING had not been given.

See the cmake-properties(7) manual for a list of properties in each scope.