diff options
| author | Kitware Robot <kwrobot@kitware.com> | 2013-10-15 11:17:36 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-10-15 14:12:03 -0400 |
| commit | f051814ed0e63badbfd68049354f36259dbf4b49 (patch) | |
| tree | f4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/prop_tgt | |
| parent | e94958e99c4dec26c86ce8b76d744c04ba960675 (diff) | |
| download | cmake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz | |
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:
./convert-help.bash "/path/to/CMake-build/bin"
Then remove it.
Diffstat (limited to 'Help/prop_tgt')
141 files changed, 2250 insertions, 0 deletions
diff --git a/Help/prop_tgt/ALIASED_TARGET.rst b/Help/prop_tgt/ALIASED_TARGET.rst new file mode 100644 index 0000000000..0af436550d --- /dev/null +++ b/Help/prop_tgt/ALIASED_TARGET.rst @@ -0,0 +1,7 @@ +ALIASED_TARGET +-------------- + +Name of target aliased by this target. + +If this is an ALIAS target, this property contains the name of the +target aliased. diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000000..f8efefbd96 --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst @@ -0,0 +1,18 @@ +ARCHIVE_OUTPUT_DIRECTORY +------------------------ + +Output directory in which to build ARCHIVE target files. + +This property specifies the directory into which archive target files +should be built. Multi-configuration generators (VS, Xcode) append a +per-configuration subdirectory to the specified directory. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. This +property is initialized by the value of the variable +CMAKE_ARCHIVE_OUTPUT_DIRECTORY if it is set when a target is created. diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000000..3c0c4fdffe --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,11 @@ +ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> +--------------------------------- + +Per-configuration output directory for ARCHIVE target files. + +This is a per-configuration version of ARCHIVE_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst new file mode 100644 index 0000000000..4784affc02 --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst @@ -0,0 +1,15 @@ +ARCHIVE_OUTPUT_NAME +------------------- + +Output name for ARCHIVE target files. + +This property specifies the base name for archive target files. It +overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000000..314fa58b6b --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +ARCHIVE_OUTPUT_NAME_<CONFIG> +---------------------------- + +Per-configuration output name for ARCHIVE target files. + +This is the configuration-specific version of ARCHIVE_OUTPUT_NAME. diff --git a/Help/prop_tgt/AUTOMOC.rst b/Help/prop_tgt/AUTOMOC.rst new file mode 100644 index 0000000000..8af11160c4 --- /dev/null +++ b/Help/prop_tgt/AUTOMOC.rst @@ -0,0 +1,31 @@ +AUTOMOC +------- + +Should the target be processed with automoc (for Qt projects). + +AUTOMOC is a boolean specifying whether CMake will handle the Qt moc +preprocessor automatically, i.e. without having to use the +QT4_WRAP_CPP() or QT5_WRAP_CPP() macro. Currently Qt4 and Qt5 are +supported. When this property is set to TRUE, CMake will scan the +source files at build time and invoke moc accordingly. If an #include +statement like #include "moc_foo.cpp" is found, the Q_OBJECT class +declaration is expected in the header, and moc is run on the header +file. If an #include statement like #include "foo.moc" is found, then +a Q_OBJECT is expected in the current source file and moc is run on +the file itself. Additionally, all header files are parsed for +Q_OBJECT macros, and if found, moc is also executed on those files. +The resulting moc files, which are not included as shown above in any +of the source files are included in a generated +<targetname>_automoc.cpp file, which is compiled as part of the +target.This property is initialized by the value of the variable +CMAKE_AUTOMOC if it is set when a target is created. + +Additional command line options for moc can be set via the +AUTOMOC_MOC_OPTIONS property. + +By setting the CMAKE_AUTOMOC_RELAXED_MODE variable to TRUE the rules +for searching the files which will be processed by moc can be relaxed. +See the documentation for this variable for more details. + +The global property AUTOMOC_TARGETS_FOLDER can be used to group the +automoc targets together in an IDE, e.g. in MSVS. diff --git a/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst b/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst new file mode 100644 index 0000000000..6ab5c85f6a --- /dev/null +++ b/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst @@ -0,0 +1,12 @@ +AUTOMOC_MOC_OPTIONS +------------------- + +Additional options for moc when using automoc (see the AUTOMOC property) + +This property is only used if the AUTOMOC property is set to TRUE for +this target. In this case, it holds additional command line options +which will be used when moc is executed during the build, i.e. it is +equivalent to the optional OPTIONS argument of the qt4_wrap_cpp() +macro. + +By default it is empty. diff --git a/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst b/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst new file mode 100644 index 0000000000..abcf28ffdb --- /dev/null +++ b/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst @@ -0,0 +1,11 @@ +BUILD_WITH_INSTALL_RPATH +------------------------ + +Should build tree targets have install tree rpaths. + +BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link the +target in the build tree with the INSTALL_RPATH. This takes +precedence over SKIP_BUILD_RPATH and avoids the need for relinking +before installation. This property is initialized by the value of the +variable CMAKE_BUILD_WITH_INSTALL_RPATH if it is set when a target is +created. diff --git a/Help/prop_tgt/BUNDLE.rst b/Help/prop_tgt/BUNDLE.rst new file mode 100644 index 0000000000..166659fb29 --- /dev/null +++ b/Help/prop_tgt/BUNDLE.rst @@ -0,0 +1,9 @@ +BUNDLE +------ + +This target is a CFBundle on the Mac. + +If a module library target has this property set to true it will be +built as a CFBundle when built on the mac. It will have the directory +structure required for a CFBundle and will be suitable to be used for +creating Browser Plugins or other application resources. diff --git a/Help/prop_tgt/BUNDLE_EXTENSION.rst b/Help/prop_tgt/BUNDLE_EXTENSION.rst new file mode 100644 index 0000000000..94ac935bcf --- /dev/null +++ b/Help/prop_tgt/BUNDLE_EXTENSION.rst @@ -0,0 +1,7 @@ +BUNDLE_EXTENSION +---------------- + +The file extension used to name a BUNDLE target on the Mac. + +The default value is "bundle" - you can also use "plugin" or whatever +file extension is required by the host app for your bundle. diff --git a/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst b/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst new file mode 100644 index 0000000000..7f95ef0426 --- /dev/null +++ b/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst @@ -0,0 +1,17 @@ +COMPATIBLE_INTERFACE_BOOL +------------------------- + +Properties which must be compatible with their link interface + +The COMPATIBLE_INTERFACE_BOOL property may contain a list of +propertiesfor this target which must be consistent when evaluated as a +boolean in the INTERFACE of all linked dependees. For example, if a +property "FOO" appears in the list, then for each dependee, the +"INTERFACE_FOO" property content in all of its dependencies must be +consistent with each other, and with the "FOO" property in the +dependee. Consistency in this sense has the meaning that if the +property is set, then it must have the same boolean value as all +others, and if the property is not set, then it is ignored. Note that +for each dependee, the set of properties from this property must not +intersect with the set of properties from the +COMPATIBLE_INTERFACE_STRING property. diff --git a/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst b/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst new file mode 100644 index 0000000000..a461f76331 --- /dev/null +++ b/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst @@ -0,0 +1,15 @@ +COMPATIBLE_INTERFACE_STRING +--------------------------- + +Properties which must be string-compatible with their link interface + +The COMPATIBLE_INTERFACE_STRING property may contain a list of +properties for this target which must be the same when evaluated as a +string in the INTERFACE of all linked dependees. For example, if a +property "FOO" appears in the list, then for each dependee, the +"INTERFACE_FOO" property content in all of its dependencies must be +equal with each other, and with the "FOO" property in the dependee. +If the property is not set, then it is ignored. Note that for each +dependee, the set of properties from this property must not intersect +with the set of properties from the COMPATIBLE_INTERFACE_BOOL +property. diff --git a/Help/prop_tgt/COMPILE_DEFINITIONS.rst b/Help/prop_tgt/COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000000..dabc0224c8 --- /dev/null +++ b/Help/prop_tgt/COMPILE_DEFINITIONS.rst @@ -0,0 +1,114 @@ +COMPILE_DEFINITIONS +------------------- + +Preprocessor definitions for compiling a target's sources. + +The COMPILE_DEFINITIONS property may be set to a semicolon-separated +list of preprocessor definitions using the syntax VAR or VAR=value. +Function-style definitions are not supported. CMake will +automatically escape the value correctly for the native build system +(note that CMake language syntax may require escapes to specify some +values). This property may be set on a per-configuration basis using +the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case +name (ex. "COMPILE_DEFINITIONS_DEBUG"). + +CMake will automatically drop some definitions that are not supported +by the native build tool. The VS6 IDE does not support definition +values with spaces (but NMake does). + +Contents of COMPILE_DEFINITIONS may use "generator expressions" with +the syntax "$<...>". Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. + +Disclaimer: Most native build tools have poor support for escaping +certain values. CMake has work-arounds for many cases but some values +may just not be possible to pass correctly. If a value does not seem +to be escaped correctly, do not attempt to work-around the problem by +adding escape sequences to the value. Your work-around may break in a +future version of CMake that has improved escape support. Instead +consider defining the macro in a (configured) header file. Then +report the limitation. Known limitations include: + +:: + + # - broken almost everywhere + ; - broken in VS IDE 7.0 and Borland Makefiles + , - broken in VS IDE + % - broken in some cases in NMake + & | - broken in some cases on MinGW + ^ < > \" - broken in most Make tools on Windows + +CMake does not reject these values outright because they do work in +some cases. Use with caution. diff --git a/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst b/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst new file mode 100644 index 0000000000..0adb7dd27c --- /dev/null +++ b/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst @@ -0,0 +1,6 @@ +COMPILE_DEFINITIONS_<CONFIG> +---------------------------- + +Per-configuration preprocessor definitions on a target. + +This is the configuration-specific version of COMPILE_DEFINITIONS. diff --git a/Help/prop_tgt/COMPILE_FLAGS.rst b/Help/prop_tgt/COMPILE_FLAGS.rst new file mode 100644 index 0000000000..6ee6c51486 --- /dev/null +++ b/Help/prop_tgt/COMPILE_FLAGS.rst @@ -0,0 +1,11 @@ +COMPILE_FLAGS +------------- + +Additional flags to use when compiling this target's sources. + +The COMPILE_FLAGS property sets additional compiler flags used to +build sources within the target. Use COMPILE_DEFINITIONS to pass +additional preprocessor definitions. + +This property is deprecated. Use the COMPILE_OPTIONS property or the +target_compile_options command instead. diff --git a/Help/prop_tgt/COMPILE_OPTIONS.rst b/Help/prop_tgt/COMPILE_OPTIONS.rst new file mode 100644 index 0000000000..d0b63685fa --- /dev/null +++ b/Help/prop_tgt/COMPILE_OPTIONS.rst @@ -0,0 +1,86 @@ +COMPILE_OPTIONS +--------------- + +List of options to pass to the compiler. + +This property specifies the list of options specified so far for this +property. This property exists on directories and targets. + +The target property values are used by the generators to set the +options for the compiler. + +Contents of COMPILE_OPTIONS may use "generator expressions" with the +syntax "$<...>". Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst b/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst new file mode 100644 index 0000000000..f2c875ef55 --- /dev/null +++ b/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst @@ -0,0 +1,7 @@ +<CONFIG>_OUTPUT_NAME +-------------------- + +Old per-configuration target file base name. + +This is a configuration-specific version of OUTPUT_NAME. Use +OUTPUT_NAME_<CONFIG> instead. diff --git a/Help/prop_tgt/CONFIG_POSTFIX.rst b/Help/prop_tgt/CONFIG_POSTFIX.rst new file mode 100644 index 0000000000..11b50b900f --- /dev/null +++ b/Help/prop_tgt/CONFIG_POSTFIX.rst @@ -0,0 +1,10 @@ +<CONFIG>_POSTFIX +---------------- + +Postfix to append to the target file name for configuration <CONFIG>. + +When building with configuration <CONFIG> the value of this property +is appended to the target file name built on disk. For non-executable +targets, this property is initialized by the value of the variable +CMAKE_<CONFIG>_POSTFIX if it is set when a target is created. This +property is ignored on the Mac for Frameworks and App Bundles. diff --git a/Help/prop_tgt/DEBUG_POSTFIX.rst b/Help/prop_tgt/DEBUG_POSTFIX.rst new file mode 100644 index 0000000000..1487656d95 --- /dev/null +++ b/Help/prop_tgt/DEBUG_POSTFIX.rst @@ -0,0 +1,7 @@ +DEBUG_POSTFIX +------------- + +See target property <CONFIG>_POSTFIX. + +This property is a special case of the more-general <CONFIG>_POSTFIX +property for the DEBUG configuration. diff --git a/Help/prop_tgt/DEFINE_SYMBOL.rst b/Help/prop_tgt/DEFINE_SYMBOL.rst new file mode 100644 index 0000000000..f47f135eaa --- /dev/null +++ b/Help/prop_tgt/DEFINE_SYMBOL.rst @@ -0,0 +1,11 @@ +DEFINE_SYMBOL +------------- + +Define a symbol when compiling this target's sources. + +DEFINE_SYMBOL sets the name of the preprocessor symbol defined when +compiling sources in a shared library. If not set here then it is set +to target_EXPORTS by default (with some substitutions if the target is +not a valid C identifier). This is useful for headers to know whether +they are being included from inside their library or outside to +properly setup dllexport/dllimport decorations. diff --git a/Help/prop_tgt/ENABLE_EXPORTS.rst b/Help/prop_tgt/ENABLE_EXPORTS.rst new file mode 100644 index 0000000000..283f5a8b23 --- /dev/null +++ b/Help/prop_tgt/ENABLE_EXPORTS.rst @@ -0,0 +1,19 @@ +ENABLE_EXPORTS +-------------- + +Specify whether an executable exports symbols for loadable modules. + +Normally an executable does not export any symbols because it is the +final program. It is possible for an executable to export symbols to +be used by loadable modules. When this property is set to true CMake +will allow other targets to "link" to the executable with the +TARGET_LINK_LIBRARIES command. On all platforms a target-level +dependency on the executable is created for targets that link to it. +For DLL platforms an import library will be created for the exported +symbols and then used for linking. All Windows-based systems +including Cygwin are DLL platforms. For non-DLL platforms that +require all symbols to be resolved at link time, such as Mac OS X, the +module will "link" to the executable using a flag like +"-bundle_loader". For other non-DLL platforms the link rule is simply +ignored since the dynamic loader will automatically bind symbols when +the module is loaded. diff --git a/Help/prop_tgt/EXCLUDE_FROM_ALL.rst b/Help/prop_tgt/EXCLUDE_FROM_ALL.rst new file mode 100644 index 0000000000..caa5741f85 --- /dev/null +++ b/Help/prop_tgt/EXCLUDE_FROM_ALL.rst @@ -0,0 +1,10 @@ +EXCLUDE_FROM_ALL +---------------- + +Exclude the target from the all target. + +A property on a target that indicates if the target is excluded from +the default build target. If it is not, then with a Makefile for +example typing make will cause this target to be built. The same +concept applies to the default build of other generators. Installing +a target with EXCLUDE_FROM_ALL set to true has undefined behavior. diff --git a/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst new file mode 100644 index 0000000000..19270a59d9 --- /dev/null +++ b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst @@ -0,0 +1,8 @@ +EXCLUDE_FROM_DEFAULT_BUILD +-------------------------- + +Exclude target from "Build Solution". + +This property is only used by Visual Studio generators 7 and above. +When set to TRUE, the target will not be built when you press "Build +Solution". diff --git a/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst new file mode 100644 index 0000000000..655a9dee0c --- /dev/null +++ b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst @@ -0,0 +1,9 @@ +EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG> +----------------------------------- + +Per-configuration version of target exclusion from "Build Solution". + +This is the configuration-specific version of +EXCLUDE_FROM_DEFAULT_BUILD. If the generic EXCLUDE_FROM_DEFAULT_BUILD +is also set on a target, EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG> takes +precedence in configurations for which it has a value. diff --git a/Help/prop_tgt/EXPORT_NAME.rst b/Help/prop_tgt/EXPORT_NAME.rst new file mode 100644 index 0000000000..1b4247cc5b --- /dev/null +++ b/Help/prop_tgt/EXPORT_NAME.rst @@ -0,0 +1,8 @@ +EXPORT_NAME +----------- + +Exported name for target files. + +This sets the name for the IMPORTED target generated when it this +target is is exported. If not set, the logical target name is used by +default. diff --git a/Help/prop_tgt/EchoString.rst b/Help/prop_tgt/EchoString.rst new file mode 100644 index 0000000000..32ae2aa8ff --- /dev/null +++ b/Help/prop_tgt/EchoString.rst @@ -0,0 +1,7 @@ +EchoString +---------- + +A message to be displayed when the target is built. + +A message to display on some generators (such as makefiles) when the +target is built. diff --git a/Help/prop_tgt/FOLDER.rst b/Help/prop_tgt/FOLDER.rst new file mode 100644 index 0000000000..bfe4e8e166 --- /dev/null +++ b/Help/prop_tgt/FOLDER.rst @@ -0,0 +1,10 @@ +FOLDER +------ + +Set the folder name. Use to organize targets in an IDE. + +Targets with no FOLDER property will appear as top level entities in +IDEs like Visual Studio. Targets with the same FOLDER property value +will appear next to each other in a folder of that name. To nest +folders, use FOLDER values such as 'GUI/Dialogs' with '/' characters +separating folder levels. diff --git a/Help/prop_tgt/FRAMEWORK.rst b/Help/prop_tgt/FRAMEWORK.rst new file mode 100644 index 0000000000..9f472c025a --- /dev/null +++ b/Help/prop_tgt/FRAMEWORK.rst @@ -0,0 +1,9 @@ +FRAMEWORK +--------- + +This target is a framework on the Mac. + +If a shared library target has this property set to true it will be +built as a framework when built on the mac. It will have the +directory structure required for a framework and will be suitable to +be used with the -framework option diff --git a/Help/prop_tgt/Fortran_FORMAT.rst b/Help/prop_tgt/Fortran_FORMAT.rst new file mode 100644 index 0000000000..0a11d91caa --- /dev/null +++ b/Help/prop_tgt/Fortran_FORMAT.rst @@ -0,0 +1,11 @@ +Fortran_FORMAT +-------------- + +Set to FIXED or FREE to indicate the Fortran source layout. + +This property tells CMake whether the Fortran source files in a target +use fixed-format or free-format. CMake will pass the corresponding +format flag to the compiler. Use the source-specific Fortran_FORMAT +property to change the format of a specific source file. If the +variable CMAKE_Fortran_FORMAT is set when a target is created its +value is used to initialize this property. diff --git a/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst b/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst new file mode 100644 index 0000000000..9c86437644 --- /dev/null +++ b/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst @@ -0,0 +1,17 @@ +Fortran_MODULE_DIRECTORY +------------------------ + +Specify output directory for Fortran modules provided by the target. + +If the target contains Fortran source files that provide modules and +the compiler supports a module output directory this specifies the +directory in which the modules will be placed. When this property is +not set the modules will be placed in the build directory +corresponding to the target's source directory. If the variable +CMAKE_Fortran_MODULE_DIRECTORY is set when a target is created its +value is used to initialize this property. + +Note that some compilers will automatically search the module output +directory for modules USEd during compilation but others will not. If +your sources USE modules their location must be specified by +INCLUDE_DIRECTORIES regardless of this property. diff --git a/Help/prop_tgt/GENERATOR_FILE_NAME.rst b/Help/prop_tgt/GENERATOR_FILE_NAME.rst new file mode 100644 index 0000000000..032b22acf4 --- /dev/null +++ b/Help/prop_tgt/GENERATOR_FILE_NAME.rst @@ -0,0 +1,9 @@ +GENERATOR_FILE_NAME +------------------- + +Generator's file for this target. + +An internal property used by some generators to record the name of the +project or dsp file associated with this target. Note that at +configure time, this property is only set for targets created by +include_external_msproject(). diff --git a/Help/prop_tgt/GNUtoMS.rst b/Help/prop_tgt/GNUtoMS.rst new file mode 100644 index 0000000000..cf34da9c3e --- /dev/null +++ b/Help/prop_tgt/GNUtoMS.rst @@ -0,0 +1,17 @@ +GNUtoMS +------- + +Convert GNU import library (.dll.a) to MS format (.lib). + +When linking a shared library or executable that exports symbols using +GNU tools on Windows (MinGW/MSYS) with Visual Studio installed convert +the import library (.dll.a) from GNU to MS format (.lib). Both import +libraries will be installed by install(TARGETS) and exported by +install(EXPORT) and export() to be linked by applications with either +GNU- or MS-compatible tools. + +If the variable CMAKE_GNUtoMS is set when a target is created its +value is used to initialize this property. The variable must be set +prior to the first command that enables a language such as project() +or enable_language(). CMake provides the variable as an option to the +user automatically when configuring on Windows with GNU tools. diff --git a/Help/prop_tgt/HAS_CXX.rst b/Help/prop_tgt/HAS_CXX.rst new file mode 100644 index 0000000000..7790932aea --- /dev/null +++ b/Help/prop_tgt/HAS_CXX.rst @@ -0,0 +1,7 @@ +HAS_CXX +------- + +Link the target using the C++ linker tool (obsolete). + +This is equivalent to setting the LINKER_LANGUAGE property to CXX. +See that property's documentation for details. diff --git a/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst b/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst new file mode 100644 index 0000000000..dc738071d4 --- /dev/null +++ b/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst @@ -0,0 +1,32 @@ +IMPLICIT_DEPENDS_INCLUDE_TRANSFORM +---------------------------------- + +Specify #include line transforms for dependencies in a target. + +This property specifies rules to transform macro-like #include lines +during implicit dependency scanning of C and C++ source files. The +list of rules must be semicolon-separated with each entry of the form +"A_MACRO(%)=value-with-%" (the % must be literal). During dependency +scanning occurrences of A_MACRO(...) on #include lines will be +replaced by the value given with the macro argument substituted for +'%'. For example, the entry + +:: + + MYDIR(%)=<mydir/%> + +will convert lines of the form + +:: + + #include MYDIR(myheader.h) + +to + +:: + + #include <mydir/myheader.h> + +allowing the dependency to be followed. + +This property applies to sources in the target on which it is set. diff --git a/Help/prop_tgt/IMPORTED.rst b/Help/prop_tgt/IMPORTED.rst new file mode 100644 index 0000000000..bf9835e294 --- /dev/null +++ b/Help/prop_tgt/IMPORTED.rst @@ -0,0 +1,8 @@ +IMPORTED +-------- + +Read-only indication of whether a target is IMPORTED. + +The boolean value of this property is true for targets created with +the IMPORTED option to add_executable or add_library. It is false for +targets built within the project. diff --git a/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst b/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst new file mode 100644 index 0000000000..6de1baa235 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst @@ -0,0 +1,11 @@ +IMPORTED_CONFIGURATIONS +----------------------- + +Configurations provided for an IMPORTED target. + +Set this to the list of configuration names available for an IMPORTED +target. The names correspond to configurations defined in the project +from which the target is imported. If the importing project uses a +different set of configurations the names may be mapped using the +MAP_IMPORTED_CONFIG_<CONFIG> property. Ignored for non-imported +targets. diff --git a/Help/prop_tgt/IMPORTED_IMPLIB.rst b/Help/prop_tgt/IMPORTED_IMPLIB.rst new file mode 100644 index 0000000000..acf4b321f8 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_IMPLIB.rst @@ -0,0 +1,7 @@ +IMPORTED_IMPLIB +--------------- + +Full path to the import library for an IMPORTED target. + +Set this to the location of the ".lib" part of a windows DLL. Ignored +for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst b/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst new file mode 100644 index 0000000000..b4b3f0228d --- /dev/null +++ b/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_IMPLIB_<CONFIG> +------------------------ + +<CONFIG>-specific version of IMPORTED_IMPLIB property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst new file mode 100644 index 0000000000..2db2b0e58c --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst @@ -0,0 +1,14 @@ +IMPORTED_LINK_DEPENDENT_LIBRARIES +--------------------------------- + +Dependent shared libraries of an imported shared library. + +Shared libraries may be linked to other shared libraries as part of +their implementation. On some platforms the linker searches for the +dependent libraries of shared libraries they are including in the +link. Set this property to the list of dependent shared libraries of +an imported library. The list should be disjoint from the list of +interface libraries in the INTERFACE_LINK_LIBRARIES property. On +platforms requiring dependent shared libraries to be found at link +time CMake uses this list to add appropriate files or paths to the +link command line. Ignored for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000000..ee243c75da --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst @@ -0,0 +1,8 @@ +IMPORTED_LINK_DEPENDENT_LIBRARIES_<CONFIG> +------------------------------------------ + +<CONFIG>-specific version of IMPORTED_LINK_DEPENDENT_LIBRARIES. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst new file mode 100644 index 0000000000..5ca9c8b6f7 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst @@ -0,0 +1,14 @@ +IMPORTED_LINK_INTERFACE_LANGUAGES +--------------------------------- + +Languages compiled into an IMPORTED static library. + +Set this to the list of languages of source files compiled to produce +a STATIC IMPORTED library (such as "C" or "CXX"). CMake accounts for +these languages when computing how to link a target to the imported +library. For example, when a C executable links to an imported C++ +static library CMake chooses the C++ linker to satisfy language +runtime dependencies of the static library. + +This property is ignored for targets that are not STATIC libraries. +This property is ignored for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst new file mode 100644 index 0000000000..d4a10fbddc --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst @@ -0,0 +1,8 @@ +IMPORTED_LINK_INTERFACE_LANGUAGES_<CONFIG> +------------------------------------------ + +<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LANGUAGES. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst new file mode 100644 index 0000000000..61134a4019 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst @@ -0,0 +1,16 @@ +IMPORTED_LINK_INTERFACE_LIBRARIES +--------------------------------- + +Transitive link interface of an IMPORTED target. + +Set this to the list of libraries whose interface is included when an +IMPORTED library target is linked to another target. The libraries +will be included on the link line for the target. Unlike the +LINK_INTERFACE_LIBRARIES property, this property applies to all +imported target types, including STATIC libraries. This property is +ignored for non-imported targets. + +This property is ignored if the target also has a non-empty +INTERFACE_LINK_LIBRARIES property. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000000..13b93ba98d --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst @@ -0,0 +1,13 @@ +IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG> +------------------------------------------ + +<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LIBRARIES. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. + +This property is ignored if the target also has a non-empty +INTERFACE_LINK_LIBRARIES property. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst new file mode 100644 index 0000000000..3a86b9985f --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst @@ -0,0 +1,6 @@ +IMPORTED_LINK_INTERFACE_MULTIPLICITY +------------------------------------ + +Repetition count for cycles of IMPORTED static libraries. + +This is LINK_INTERFACE_MULTIPLICITY for IMPORTED targets. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst new file mode 100644 index 0000000000..33b9b84199 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG> +--------------------------------------------- + +<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_MULTIPLICITY. + +If set, this property completely overrides the generic property for +the named configuration. diff --git a/Help/prop_tgt/IMPORTED_LOCATION.rst b/Help/prop_tgt/IMPORTED_LOCATION.rst new file mode 100644 index 0000000000..8cfef7343b --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LOCATION.rst @@ -0,0 +1,21 @@ +IMPORTED_LOCATION +----------------- + +Full path to the main file on disk for an IMPORTED target. + +Set this to the location of an IMPORTED target file on disk. For +executables this is the location of the executable file. For bundles +on OS X this is the location of the executable file inside +Contents/MacOS under the application bundle folder. For static +libraries and modules this is the location of the library or module. +For shared libraries on non-DLL platforms this is the location of the +shared library. For frameworks on OS X this is the location of the +library file symlink just inside the framework folder. For DLLs this +is the location of the ".dll" part of the library. For UNKNOWN +libraries this is the location of the file to be linked. Ignored for +non-imported targets. + +Projects may skip IMPORTED_LOCATION if the configuration-specific +property IMPORTED_LOCATION_<CONFIG> is set. To get the location of an +imported target read one of the LOCATION or LOCATION_<CONFIG> +properties. diff --git a/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst b/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst new file mode 100644 index 0000000000..f85bb19c93 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_LOCATION_<CONFIG> +-------------------------- + +<CONFIG>-specific version of IMPORTED_LOCATION property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORTED_NO_SONAME.rst b/Help/prop_tgt/IMPORTED_NO_SONAME.rst new file mode 100644 index 0000000000..4a1bb447ac --- /dev/null +++ b/Help/prop_tgt/IMPORTED_NO_SONAME.rst @@ -0,0 +1,9 @@ +IMPORTED_NO_SONAME +------------------ + +Specifies that an IMPORTED shared library target has no "soname". + +Set this property to true for an imported shared library file that has +no "soname" field. CMake may adjust generated link commands for some +platforms to prevent the linker from using the path to the library in +place of its missing soname. Ignored for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst b/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst new file mode 100644 index 0000000000..22d68220c8 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_NO_SONAME_<CONFIG> +--------------------------- + +<CONFIG>-specific version of IMPORTED_NO_SONAME property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORTED_SONAME.rst b/Help/prop_tgt/IMPORTED_SONAME.rst new file mode 100644 index 0000000000..d80907e3e8 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_SONAME.rst @@ -0,0 +1,8 @@ +IMPORTED_SONAME +--------------- + +The "soname" of an IMPORTED target of shared library type. + +Set this to the "soname" embedded in an imported shared library. This +is meaningful only on platforms supporting the feature. Ignored for +non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst b/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst new file mode 100644 index 0000000000..6ec9af3f83 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_SONAME_<CONFIG> +------------------------ + +<CONFIG>-specific version of IMPORTED_SONAME property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORT_PREFIX.rst b/Help/prop_tgt/IMPORT_PREFIX.rst new file mode 100644 index 0000000000..deede97880 --- /dev/null +++ b/Help/prop_tgt/IMPORT_PREFIX.rst @@ -0,0 +1,9 @@ +IMPORT_PREFIX +------------- + +What comes before the import library name. + +Similar to the target property PREFIX, but used for import libraries +(typically corresponding to a DLL) instead of regular libraries. A +target property that can be set to override the prefix (such as "lib") +on an import library name. diff --git a/Help/prop_tgt/IMPORT_SUFFIX.rst b/Help/prop_tgt/IMPORT_SUFFIX.rst new file mode 100644 index 0000000000..bd01250378 --- /dev/null +++ b/Help/prop_tgt/IMPORT_SUFFIX.rst @@ -0,0 +1,9 @@ +IMPORT_SUFFIX +------------- + +What comes after the import library name. + +Similar to the target property SUFFIX, but used for import libraries +(typically corresponding to a DLL) instead of regular libraries. A +target property that can be set to override the suffix (such as +".lib") on an import library name. diff --git a/Help/prop_tgt/INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000000..0e13e12931 --- /dev/null +++ b/Help/prop_tgt/INCLUDE_DIRECTORIES.rst @@ -0,0 +1,94 @@ +INCLUDE_DIRECTORIES +------------------- + +List of preprocessor include file search directories. + +This property specifies the list of directories given so far to the +include_directories command. This property exists on directories and +targets. In addition to accepting values from the include_directories +command, values may be set directly on any directory or any target +using the set_property command. A target gets its initial value for +this property from the value of the directory property. A directory +gets its initial value from its parent directory if it has one. Both +directory and target property values are adjusted by calls to the +include_directories command. + +The target property values are used by the generators to set the +include paths for the compiler. See also the include_directories +command. + +Contents of INCLUDE_DIRECTORIES may use "generator expressions" with +the syntax "$<...>". Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INSTALL_NAME_DIR.rst b/Help/prop_tgt/INSTALL_NAME_DIR.rst new file mode 100644 index 0000000000..a67ec15849 --- /dev/null +++ b/Help/prop_tgt/INSTALL_NAME_DIR.rst @@ -0,0 +1,8 @@ +INSTALL_NAME_DIR +---------------- + +Mac OSX directory name for installed targets. + +INSTALL_NAME_DIR is a string specifying the directory portion of the +"install_name" field of shared libraries on Mac OSX to use in the +installed targets. diff --git a/Help/prop_tgt/INSTALL_RPATH.rst b/Help/prop_tgt/INSTALL_RPATH.rst new file mode 100644 index 0000000000..6206b6889b --- /dev/null +++ b/Help/prop_tgt/INSTALL_RPATH.rst @@ -0,0 +1,9 @@ +INSTALL_RPATH +------------- + +The rpath to use for installed targets. + +A semicolon-separated list specifying the rpath to use in installed +targets (for platforms that support it). This property is initialized +by the value of the variable CMAKE_INSTALL_RPATH if it is set when a +target is created. diff --git a/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst b/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst new file mode 100644 index 0000000000..f0006f85b3 --- /dev/null +++ b/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst @@ -0,0 +1,10 @@ +INSTALL_RPATH_USE_LINK_PATH +--------------------------- + +Add paths to linker search and installed rpath. + +INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true will +append directories in the linker search path and outside the project +to the INSTALL_RPATH. This property is initialized by the value of +the variable CMAKE_INSTALL_RPATH_USE_LINK_PATH if it is set when a +target is created. diff --git a/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst b/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000000..7221c6ba12 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst @@ -0,0 +1,85 @@ +INTERFACE_COMPILE_DEFINITIONS +----------------------------- + +List of public compile definitions for a library. + +Targets may populate this property to publish the compile definitions +required to compile against the headers for the target. Consuming +targets can add entries to their own COMPILE_DEFINITIONS property such +as $<TARGET_PROPERTY:foo,INTERFACE_COMPILE_DEFINITIONS> to use the +compile definitions specified in the interface of 'foo'. + +Generator expressions are evaluated during build system generation to +produce information specific to each build configuration. Valid +expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst b/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst new file mode 100644 index 0000000000..99b5173704 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst @@ -0,0 +1,85 @@ +INTERFACE_COMPILE_OPTIONS +------------------------- + +List of interface options to pass to the compiler. + +Targets may populate this property to publish the compile options +required to compile against the headers for the target. Consuming +targets can add entries to their own COMPILE_OPTIONS property such as +$<TARGET_PROPERTY:foo,INTERFACE_COMPILE_OPTIONS> to use the compile +options specified in the interface of 'foo'. + +Generator expressions are evaluated during build system generation to +produce information specific to each build configuration. Valid +expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000000..9d8dc8dbf4 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst @@ -0,0 +1,85 @@ +INTERFACE_INCLUDE_DIRECTORIES +----------------------------- + +List of public include directories for a library. + +Targets may populate this property to publish the include directories +required to compile against the headers for the target. Consuming +targets can add entries to their own INCLUDE_DIRECTORIES property such +as $<TARGET_PROPERTY:foo,INTERFACE_INCLUDE_DIRECTORIES> to use the +include directories specified in the interface of 'foo'. + +Generator expressions are evaluated during build system generation to +produce information specific to each build configuration. Valid +expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst new file mode 100644 index 0000000000..e272ee9f7d --- /dev/null +++ b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst @@ -0,0 +1,88 @@ +INTERFACE_LINK_LIBRARIES +------------------------ + +List public interface libraries for a shared library or executable. + +This property contains the list of transitive link dependencies. When +the target is linked into another target the libraries listed (and +recursively their link interface libraries) will be provided to the +other target also. This property is overriden by the +LINK_INTERFACE_LIBRARIES or LINK_INTERFACE_LIBRARIES_<CONFIG> property +if policy CMP0022 is OLD or unset. + + + +Generator expressions are evaluated during build system generation to +produce information specific to each build configuration. Valid +expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst b/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst new file mode 100644 index 0000000000..76c1e06f43 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst @@ -0,0 +1,15 @@ +INTERFACE_POSITION_INDEPENDENT_CODE +----------------------------------- + +Whether consumers need to create a position-independent target + +The INTERFACE_POSITION_INDEPENDENT_CODE property informs consumers of +this target whether they must set their POSITION_INDEPENDENT_CODE +property to ON. If this property is set to ON, then the +POSITION_INDEPENDENT_CODE property on all consumers will be set to ON. +Similarly, if this property is set to OFF, then the +POSITION_INDEPENDENT_CODE property on all consumers will be set to +OFF. If this property is undefined, then consumers will determine +their POSITION_INDEPENDENT_CODE property by other means. Consumers +must ensure that the targets that they link to have a consistent +requirement for their INTERFACE_POSITION_INDEPENDENT_CODE property. diff --git a/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000000..41b43e4143 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst @@ -0,0 +1,84 @@ +INTERFACE_SYSTEM_INCLUDE_DIRECTORIES +------------------------------------ + +List of public system include directories for a library. + +Targets may populate this property to publish the include directories +which contain system headers, and therefore should not result in +compiler warnings. Consuming targets will then mark the same include +directories as system headers. + +Generator expressions are evaluated during build system generation to +produce information specific to each build configuration. Valid +expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst new file mode 100644 index 0000000000..effa3b01f8 --- /dev/null +++ b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst @@ -0,0 +1,7 @@ +INTERPROCEDURAL_OPTIMIZATION +---------------------------- + +Enable interprocedural optimization for a target. + +If set to true, enables interprocedural optimizations if they are +known to be supported by the compiler. diff --git a/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst new file mode 100644 index 0000000000..492fee0789 --- /dev/null +++ b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst @@ -0,0 +1,8 @@ +INTERPROCEDURAL_OPTIMIZATION_<CONFIG> +------------------------------------- + +Per-configuration interprocedural optimization for a target. + +This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. +If set, this property overrides the generic property for the named +configuration. diff --git a/Help/prop_tgt/LABELS.rst b/Help/prop_tgt/LABELS.rst new file mode 100644 index 0000000000..5e464696dc --- /dev/null +++ b/Help/prop_tgt/LABELS.rst @@ -0,0 +1,6 @@ +LABELS +------ + +Specify a list of text labels associated with a target. + +Target label semantics are currently unspecified. diff --git a/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst b/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst new file mode 100644 index 0000000000..d4bde179b7 --- /dev/null +++ b/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst @@ -0,0 +1,10 @@ +<LANG>_VISIBILITY_PRESET +------------------------ + +Value for symbol visibility compile flags + +The <LANG>_VISIBILITY_PRESET property determines the value passed in a +visibility related compile option, such as -fvisibility= for <LANG>. +This property only has an affect for libraries and executables with +exports. This property is initialized by the value of the variable +CMAKE_<LANG>_VISIBILITY_PRESET if it is set when a target is created. diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000000..a0ba619e0a --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst @@ -0,0 +1,18 @@ +LIBRARY_OUTPUT_DIRECTORY +------------------------ + +Output directory in which to build LIBRARY target files. + +This property specifies the directory into which library target files +should be built. Multi-configuration generators (VS, Xcode) append a +per-configuration subdirectory to the specified directory. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. This +property is initialized by the value of the variable +CMAKE_LIBRARY_OUTPUT_DIRECTORY if it is set when a target is created. diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000000..2a38373054 --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,11 @@ +LIBRARY_OUTPUT_DIRECTORY_<CONFIG> +--------------------------------- + +Per-configuration output directory for LIBRARY target files. + +This is a per-configuration version of LIBRARY_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_LIBRARY_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst b/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst new file mode 100644 index 0000000000..1330e0d681 --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst @@ -0,0 +1,15 @@ +LIBRARY_OUTPUT_NAME +------------------- + +Output name for LIBRARY target files. + +This property specifies the base name for library target files. It +overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000000..785d1b2dc3 --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +LIBRARY_OUTPUT_NAME_<CONFIG> +---------------------------- + +Per-configuration output name for LIBRARY target files. + +This is the configuration-specific version of LIBRARY_OUTPUT_NAME. diff --git a/Help/prop_tgt/LINKER_LANGUAGE.rst b/Help/prop_tgt/LINKER_LANGUAGE.rst new file mode 100644 index 0000000000..b1ca86710e --- /dev/null +++ b/Help/prop_tgt/LINKER_LANGUAGE.rst @@ -0,0 +1,14 @@ +LINKER_LANGUAGE +--------------- + +Specifies language whose compiler will invoke the linker. + +For executables, shared libraries, and modules, this sets the language +whose compiler is used to link the target (such as "C" or "CXX"). A +typical value for an executable is the language of the source file +providing the program entry point (main). If not set, the language +with the highest linker preference value is the default. See +documentation of CMAKE_<LANG>_LINKER_PREFERENCE variables. + +If this property is not set by the user, it will be calculated at +generate-time by CMake. diff --git a/Help/prop_tgt/LINK_DEPENDS.rst b/Help/prop_tgt/LINK_DEPENDS.rst new file mode 100644 index 0000000000..5576b85fa6 --- /dev/null +++ b/Help/prop_tgt/LINK_DEPENDS.rst @@ -0,0 +1,12 @@ +LINK_DEPENDS +------------ + +Additional files on which a target binary depends for linking. + +Specifies a semicolon-separated list of full-paths to files on which +the link rule for this target depends. The target binary will be +linked if any of the named files is newer than it. + +This property is ignored by non-Makefile generators. It is intended +to specify dependencies on "linker scripts" for custom Makefile link +rules. diff --git a/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst b/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst new file mode 100644 index 0000000000..5c6778d245 --- /dev/null +++ b/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst @@ -0,0 +1,14 @@ +LINK_DEPENDS_NO_SHARED +---------------------- + +Do not depend on linked shared library files. + +Set this property to true to tell CMake generators not to add +file-level dependencies on the shared library files linked by this +target. Modification to the shared libraries will not be sufficient +to re-link this target. Logical target-level dependencies will not be +affected so the linked shared libraries will still be brought up to +date before this target is built. + +This property is initialized by the value of the variable +CMAKE_LINK_DEPENDS_NO_SHARED if it is set when a target is created. diff --git a/Help/prop_tgt/LINK_FLAGS.rst b/Help/prop_tgt/LINK_FLAGS.rst new file mode 100644 index 0000000000..409d00a291 --- /dev/null +++ b/Help/prop_tgt/LINK_FLAGS.rst @@ -0,0 +1,8 @@ +LINK_FLAGS +---------- + +Additional flags to use when linking this target. + +The LINK_FLAGS property can be used to add extra flags to the link +step of a target. LINK_FLAGS_<CONFIG> will add to the configuration +<CONFIG>, for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO. diff --git a/Help/prop_tgt/LINK_FLAGS_CONFIG.rst b/Help/prop_tgt/LINK_FLAGS_CONFIG.rst new file mode 100644 index 0000000000..ba7adc84f6 --- /dev/null +++ b/Help/prop_tgt/LINK_FLAGS_CONFIG.rst @@ -0,0 +1,6 @@ +LINK_FLAGS_<CONFIG> +------------------- + +Per-configuration linker flags for a target. + +This is the configuration-specific version of LINK_FLAGS. diff --git a/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst new file mode 100644 index 0000000000..75c2a31034 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst @@ -0,0 +1,22 @@ +LINK_INTERFACE_LIBRARIES +------------------------ + +List public interface libraries for a shared library or executable. + +By default linking to a shared library target transitively links to +targets with which the library itself was linked. For an executable +with exports (see the ENABLE_EXPORTS property) no default transitive +link dependencies are used. This property replaces the default +transitive link dependencies with an explicit list. When the target +is linked into another target the libraries listed (and recursively +their link interface libraries) will be provided to the other target +also. If the list is empty then no transitive link dependencies will +be incorporated when this target is linked into another target even if +the default set is non-empty. This property is initialized by the +value of the variable CMAKE_LINK_INTERFACE_LIBRARIES if it is set when +a target is created. This property is ignored for STATIC libraries. + +This property is overriden by the INTERFACE_LINK_LIBRARIES property if +policy CMP0022 is NEW. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000000..1a7a941de1 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst @@ -0,0 +1,13 @@ +LINK_INTERFACE_LIBRARIES_<CONFIG> +--------------------------------- + +Per-configuration list of public interface libraries for a target. + +This is the configuration-specific version of +LINK_INTERFACE_LIBRARIES. If set, this property completely overrides +the generic property for the named configuration. + +This property is overriden by the INTERFACE_LINK_LIBRARIES property if +policy CMP0022 is NEW. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst new file mode 100644 index 0000000000..4e26388a93 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst @@ -0,0 +1,12 @@ +LINK_INTERFACE_MULTIPLICITY +--------------------------- + +Repetition count for STATIC libraries with cyclic dependencies. + +When linking to a STATIC library target with cyclic dependencies the +linker may need to scan more than once through the archives in the +strongly connected component of the dependency graph. CMake by +default constructs the link line so that the linker will scan through +the component at least twice. This property specifies the minimum +number of scans if it is larger than the default. CMake uses the +largest value specified by any target in a component. diff --git a/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst new file mode 100644 index 0000000000..5ea4a45cf6 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst @@ -0,0 +1,8 @@ +LINK_INTERFACE_MULTIPLICITY_<CONFIG> +------------------------------------ + +Per-configuration repetition count for cycles of STATIC libraries. + +This is the configuration-specific version of +LINK_INTERFACE_MULTIPLICITY. If set, this property completely +overrides the generic property for the named configuration. diff --git a/Help/prop_tgt/LINK_LIBRARIES.rst b/Help/prop_tgt/LINK_LIBRARIES.rst new file mode 100644 index 0000000000..3095d5d3d3 --- /dev/null +++ b/Help/prop_tgt/LINK_LIBRARIES.rst @@ -0,0 +1,89 @@ +LINK_LIBRARIES +-------------- + +List of direct link dependencies. + +This property specifies the list of libraries or targets which will be +used for linking. In addition to accepting values from the +target_link_libraries command, values may be set directly on any +target using the set_property command. + +The target property values are used by the generators to set the link +libraries for the compiler. See also the target_link_libraries +command. + +Contents of LINK_LIBRARIES may use "generator expressions" with the +syntax "$<...>". Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst b/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst new file mode 100644 index 0000000000..fe105bd6c4 --- /dev/null +++ b/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst @@ -0,0 +1,14 @@ +LINK_SEARCH_END_STATIC +---------------------- + +End a link line such that static system libraries are used. + +Some linkers support switches such as -Bstatic and -Bdynamic to +determine whether to use static or shared libraries for -lXXX options. +CMake uses these options to set the link type for libraries whose full +paths are not known or (in some cases) are in implicit link +directories for the platform. By default CMake adds an option at the +end of the library list (if necessary) to set the linker search type +back to its starting type. This property switches the final linker +search type to -Bstatic regardless of how it started. See also +LINK_SEARCH_START_STATIC. diff --git a/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst b/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst new file mode 100644 index 0000000000..ca899feaa0 --- /dev/null +++ b/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst @@ -0,0 +1,14 @@ +LINK_SEARCH_START_STATIC +------------------------ + +Assume the linker looks for static libraries by default. + +Some linkers support switches such as -Bstatic and -Bdynamic to +determine whether to use static or shared libraries for -lXXX options. +CMake uses these options to set the link type for libraries whose full +paths are not known or (in some cases) are in implicit link +directories for the platform. By default the linker search type is +assumed to be -Bdynamic at the beginning of the library list. This +property switches the assumption to -Bstatic. It is intended for use +when linking an executable statically (e.g. with the GNU -static +option). See also LINK_SEARCH_END_STATIC. diff --git a/Help/prop_tgt/LOCATION.rst b/Help/prop_tgt/LOCATION.rst new file mode 100644 index 0000000000..bdcb1df9a1 --- /dev/null +++ b/Help/prop_tgt/LOCATION.rst @@ -0,0 +1,27 @@ +LOCATION +-------- + +Read-only location of a target on disk. + +For an imported target, this read-only property returns the value of +the LOCATION_<CONFIG> property for an unspecified configuration +<CONFIG> provided by the target. + +For a non-imported target, this property is provided for compatibility +with CMake 2.4 and below. It was meant to get the location of an +executable target's output file for use in add_custom_command. The +path may contain a build-system-specific portion that is replaced at +build time with the configuration getting built (such as +"$(ConfigurationName)" in VS). In CMake 2.6 and above +add_custom_command automatically recognizes a target name in its +COMMAND and DEPENDS options and computes the target location. In +CMake 2.8.4 and above add_custom_command recognizes generator +expressions to refer to target locations anywhere in the command. +Therefore this property is not needed for creating custom commands. + +Do not set properties that affect the location of a target after +reading this property. These include properties whose names match +"(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?", +"(IMPLIB_)?(PREFIX|SUFFIX)", or "LINKER_LANGUAGE". Failure to follow +this rule is not diagnosed and leaves the location of the target +undefined. diff --git a/Help/prop_tgt/LOCATION_CONFIG.rst b/Help/prop_tgt/LOCATION_CONFIG.rst new file mode 100644 index 0000000000..5c4d75bdc9 --- /dev/null +++ b/Help/prop_tgt/LOCATION_CONFIG.rst @@ -0,0 +1,20 @@ +LOCATION_<CONFIG> +----------------- + +Read-only property providing a target location on disk. + +A read-only property that indicates where a target's main file is +located on disk for the configuration <CONFIG>. The property is +defined only for library and executable targets. An imported target +may provide a set of configurations different from that of the +importing project. By default CMake looks for an exact-match but +otherwise uses an arbitrary available configuration. Use the +MAP_IMPORTED_CONFIG_<CONFIG> property to map imported configurations +explicitly. + +Do not set properties that affect the location of a target after +reading this property. These include properties whose names match +"(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?", +"(IMPLIB_)?(PREFIX|SUFFIX)", or "LINKER_LANGUAGE". Failure to follow +this rule is not diagnosed and leaves the location of the target +undefined. diff --git a/Help/prop_tgt/MACOSX_BUNDLE.rst b/Help/prop_tgt/MACOSX_BUNDLE.rst new file mode 100644 index 0000000000..ff21e61473 --- /dev/null +++ b/Help/prop_tgt/MACOSX_BUNDLE.rst @@ -0,0 +1,12 @@ +MACOSX_BUNDLE +------------- + +Build an executable as an application bundle on Mac OS X. + +When this property is set to true the executable when built on Mac OS +X will be created as an application bundle. This makes it a GUI +executable that can be launched from the Finder. See the +MACOSX_BUNDLE_INFO_PLIST target property for information about +creation of the Info.plist file for the application bundle. This +property is initialized by the value of the variable +CMAKE_MACOSX_BUNDLE if it is set when a target is created. diff --git a/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst new file mode 100644 index 0000000000..097cce1869 --- /dev/null +++ b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst @@ -0,0 +1,29 @@ +MACOSX_BUNDLE_INFO_PLIST +------------------------ + +Specify a custom Info.plist template for a Mac OS X App Bundle. + +An executable target with MACOSX_BUNDLE enabled will be built as an +application bundle on Mac OS X. By default its Info.plist file is +created by configuring a template called MacOSXBundleInfo.plist.in +located in the CMAKE_MODULE_PATH. This property specifies an +alternative template file name which may be a full path. + +The following target properties may be set to specify content to be +configured into the file: + +:: + + MACOSX_BUNDLE_INFO_STRING + MACOSX_BUNDLE_ICON_FILE + MACOSX_BUNDLE_GUI_IDENTIFIER + MACOSX_BUNDLE_LONG_VERSION_STRING + MACOSX_BUNDLE_BUNDLE_NAME + MACOSX_BUNDLE_SHORT_VERSION_STRING + MACOSX_BUNDLE_BUNDLE_VERSION + MACOSX_BUNDLE_COPYRIGHT + +CMake variables of the same name may be set to affect all targets in a +directory that do not have each specific property set. If a custom +Info.plist is specified by this property it may of course hard-code +all the settings instead of using the target properties. diff --git a/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst new file mode 100644 index 0000000000..729d929022 --- /dev/null +++ b/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst @@ -0,0 +1,25 @@ +MACOSX_FRAMEWORK_INFO_PLIST +--------------------------- + +Specify a custom Info.plist template for a Mac OS X Framework. + +A library target with FRAMEWORK enabled will be built as a framework +on Mac OS X. By default its Info.plist file is created by configuring +a template called MacOSXFrameworkInfo.plist.in located in the +CMAKE_MODULE_PATH. This property specifies an alternative template +file name which may be a full path. + +The following target properties may be set to specify content to be +configured into the file: + +:: + + MACOSX_FRAMEWORK_ICON_FILE + MACOSX_FRAMEWORK_IDENTIFIER + MACOSX_FRAMEWORK_SHORT_VERSION_STRING + MACOSX_FRAMEWORK_BUNDLE_VERSION + +CMake variables of the same name may be set to affect all targets in a +directory that do not have each specific property set. If a custom +Info.plist is specified by this property it may of course hard-code +all the settings instead of using the target properties. diff --git a/Help/prop_tgt/MACOSX_RPATH.rst b/Help/prop_tgt/MACOSX_RPATH.rst new file mode 100644 index 0000000000..f2d807865e --- /dev/null +++ b/Help/prop_tgt/MACOSX_RPATH.rst @@ -0,0 +1,10 @@ +MACOSX_RPATH +------------ + +Whether to use rpaths on Mac OS X. + +When this property is set to true, the directory portion of +the"install_name" field of shared libraries will default to +"@rpath".Runtime paths will also be embedded in binaries using this +target.This property is initialized by the value of the variable +CMAKE_MACOSX_RPATH if it is set when a target is created. diff --git a/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst b/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst new file mode 100644 index 0000000000..09ff0cee65 --- /dev/null +++ b/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst @@ -0,0 +1,19 @@ +MAP_IMPORTED_CONFIG_<CONFIG> +---------------------------- + +Map from project configuration to IMPORTED target's configuration. + +Set this to the list of configurations of an imported target that may +be used for the current project's <CONFIG> configuration. Targets +imported from another project may not provide the same set of +configuration names available in the current project. Setting this +property tells CMake what imported configurations are suitable for use +when building the <CONFIG> configuration. The first configuration in +the list found to be provided by the imported target is selected. If +this property is set and no matching configurations are available, +then the imported target is considered to be not found. This property +is ignored for non-imported targets. + +This property is initialized by the value of the variable +CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/NAME.rst b/Help/prop_tgt/NAME.rst new file mode 100644 index 0000000000..ddd84f23c5 --- /dev/null +++ b/Help/prop_tgt/NAME.rst @@ -0,0 +1,6 @@ +NAME +---- + +Logical name for the target. + +Read-only logical name for the target as used by CMake. diff --git a/Help/prop_tgt/NO_SONAME.rst b/Help/prop_tgt/NO_SONAME.rst new file mode 100644 index 0000000000..fc668b588e --- /dev/null +++ b/Help/prop_tgt/NO_SONAME.rst @@ -0,0 +1,14 @@ +NO_SONAME +--------- + +Whether to set "soname" when linking a shared library or module. + +Enable this boolean property if a generated shared library or module +should not have "soname" set. Default is to set "soname" on all +shared libraries and modules as long as the platform supports it. +Generally, use this property only for leaf private libraries or +plugins. If you use it on normal shared libraries which other targets +link against, on some platforms a linker will insert a full path to +the library (as specified at link time) into the dynamic section of +the dependent binary. Therefore, once installed, dynamic loader may +eventually fail to locate the library for the binary. diff --git a/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst b/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst new file mode 100644 index 0000000000..070dd3018b --- /dev/null +++ b/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst @@ -0,0 +1,11 @@ +NO_SYSTEM_FROM_IMPORTED +----------------------- + +Do not treat includes from IMPORTED target interfaces as SYSTEM. + +The contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED targets +are treated as SYSTEM includes by default. If this property is +enabled, the contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED +targets are not treated as system includes. This property is +initialized by the value of the variable CMAKE_NO_SYSTEM_FROM_IMPORTED +if it is set when a target is created. diff --git a/Help/prop_tgt/OSX_ARCHITECTURES.rst b/Help/prop_tgt/OSX_ARCHITECTURES.rst new file mode 100644 index 0000000000..68ff970edd --- /dev/null +++ b/Help/prop_tgt/OSX_ARCHITECTURES.rst @@ -0,0 +1,11 @@ +OSX_ARCHITECTURES +----------------- + +Target specific architectures for OS X. + +The OSX_ARCHITECTURES property sets the target binary architecture for +targets on OS X. This property is initialized by the value of the +variable CMAKE_OSX_ARCHITECTURES if it is set when a target is +created. Use OSX_ARCHITECTURES_<CONFIG> to set the binary +architectures on a per-configuration basis. <CONFIG> is an upper-case +name (ex: "OSX_ARCHITECTURES_DEBUG"). diff --git a/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst b/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst new file mode 100644 index 0000000000..ea05bead87 --- /dev/null +++ b/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst @@ -0,0 +1,7 @@ +OSX_ARCHITECTURES_<CONFIG> +-------------------------- + +Per-configuration OS X binary architectures for a target. + +This property is the configuration-specific version of +OSX_ARCHITECTURES. diff --git a/Help/prop_tgt/OUTPUT_NAME.rst b/Help/prop_tgt/OUTPUT_NAME.rst new file mode 100644 index 0000000000..97bf01094e --- /dev/null +++ b/Help/prop_tgt/OUTPUT_NAME.rst @@ -0,0 +1,8 @@ +OUTPUT_NAME +----------- + +Output name for target files. + +This sets the base name for output files created for an executable or +library target. If not set, the logical target name is used by +default. diff --git a/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000000..7bfbcbccfe --- /dev/null +++ b/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +OUTPUT_NAME_<CONFIG> +-------------------- + +Per-configuration target file base name. + +This is the configuration-specific version of OUTPUT_NAME. diff --git a/Help/prop_tgt/PDB_NAME.rst b/Help/prop_tgt/PDB_NAME.rst new file mode 100644 index 0000000000..fe059e06fc --- /dev/null +++ b/Help/prop_tgt/PDB_NAME.rst @@ -0,0 +1,10 @@ +PDB_NAME +-------- + +Output name for MS debug symbols .pdb file from linker. + +Set the base name for debug symbols file created for an executable or +shared library target. If not set, the logical target name is used by +default. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/PDB_NAME_CONFIG.rst b/Help/prop_tgt/PDB_NAME_CONFIG.rst new file mode 100644 index 0000000000..50c3aa294b --- /dev/null +++ b/Help/prop_tgt/PDB_NAME_CONFIG.rst @@ -0,0 +1,8 @@ +PDB_NAME_<CONFIG> +----------------- + +Per-configuration name for MS debug symbols .pdb file. + +This is the configuration-specific version of PDB_NAME. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000000..d973e90d96 --- /dev/null +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst @@ -0,0 +1,11 @@ +PDB_OUTPUT_DIRECTORY +-------------------- + +Output directory for MS debug symbols .pdb file from linker. + +This property specifies the directory into which the MS debug symbols +will be placed by the linker. This property is initialized by the +value of the variable CMAKE_PDB_OUTPUT_DIRECTORY if it is set when a +target is created. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000000..25ab944967 --- /dev/null +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,13 @@ +PDB_OUTPUT_DIRECTORY_<CONFIG> +----------------------------- + +Per-configuration output directory for MS debug symbols .pdb files. + +This is a per-configuration version of PDB_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst b/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst new file mode 100644 index 0000000000..120244740e --- /dev/null +++ b/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst @@ -0,0 +1,11 @@ +POSITION_INDEPENDENT_CODE +------------------------- + +Whether to create a position-independent target + +The POSITION_INDEPENDENT_CODE property determines whether position +independent executables or shared libraries will be created. This +property is true by default for SHARED and MODULE library targets and +false otherwise. This property is initialized by the value of the +variable CMAKE_POSITION_INDEPENDENT_CODE if it is set when a target is +created. diff --git a/Help/prop_tgt/POST_INSTALL_SCRIPT.rst b/Help/prop_tgt/POST_INSTALL_SCRIPT.rst new file mode 100644 index 0000000000..f1adb40b7d --- /dev/null +++ b/Help/prop_tgt/POST_INSTALL_SCRIPT.rst @@ -0,0 +1,9 @@ +POST_INSTALL_SCRIPT +------------------- + +Deprecated install support. + +The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the old +way to specify CMake scripts to run before and after installing a +target. They are used only when the old INSTALL_TARGETS command is +used to install the target. Use the INSTALL command instead. diff --git a/Help/prop_tgt/PREFIX.rst b/Help/prop_tgt/PREFIX.rst new file mode 100644 index 0000000000..a16510461d --- /dev/null +++ b/Help/prop_tgt/PREFIX.rst @@ -0,0 +1,7 @@ +PREFIX +------ + +What comes before the library name. + +A target property that can be set to override the prefix (such as +"lib") on a library name. diff --git a/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst b/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst new file mode 100644 index 0000000000..113d7c56ae --- /dev/null +++ b/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst @@ -0,0 +1,9 @@ +PRE_INSTALL_SCRIPT +------------------ + +Deprecated install support. + +The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the old +way to specify CMake scripts to run before and after installing a +target. They are used only when the old INSTALL_TARGETS command is +used to install the target. Use the INSTALL command instead. diff --git a/Help/prop_tgt/PRIVATE_HEADER.rst b/Help/prop_tgt/PRIVATE_HEADER.rst new file mode 100644 index 0000000000..da2127b180 --- /dev/null +++ b/Help/prop_tgt/PRIVATE_HEADER.rst @@ -0,0 +1,11 @@ +PRIVATE_HEADER +-------------- + +Specify private header files in a FRAMEWORK shared library target. + +Shared library targets marked with the FRAMEWORK property generate +frameworks on OS X and normal shared libraries on other platforms. +This property may be set to a list of header files to be placed in the +PrivateHeaders directory inside the framework folder. On non-Apple +platforms these headers may be installed using the PRIVATE_HEADER +option to the install(TARGETS) command. diff --git a/Help/prop_tgt/PROJECT_LABEL.rst b/Help/prop_tgt/PROJECT_LABEL.rst new file mode 100644 index 0000000000..a1491ee139 --- /dev/null +++ b/Help/prop_tgt/PROJECT_LABEL.rst @@ -0,0 +1,7 @@ +PROJECT_LABEL +------------- + +Change the name of a target in an IDE. + +Can be used to change the name of the target in an IDE like Visual +Studio. diff --git a/Help/prop_tgt/PUBLIC_HEADER.rst b/Help/prop_tgt/PUBLIC_HEADER.rst new file mode 100644 index 0000000000..6e25d94d53 --- /dev/null +++ b/Help/prop_tgt/PUBLIC_HEADER.rst @@ -0,0 +1,11 @@ +PUBLIC_HEADER +------------- + +Specify public header files in a FRAMEWORK shared library target. + +Shared library targets marked with the FRAMEWORK property generate +frameworks on OS X and normal shared libraries on other platforms. +This property may be set to a list of header files to be placed in the +Headers directory inside the framework folder. On non-Apple platforms +these headers may be installed using the PUBLIC_HEADER option to the +install(TARGETS) command. diff --git a/Help/prop_tgt/RESOURCE.rst b/Help/prop_tgt/RESOURCE.rst new file mode 100644 index 0000000000..1e9921de3b --- /dev/null +++ b/Help/prop_tgt/RESOURCE.rst @@ -0,0 +1,11 @@ +RESOURCE +-------- + +Specify resource files in a FRAMEWORK shared library target. + +Shared library targets marked with the FRAMEWORK property generate +frameworks on OS X and normal shared libraries on other platforms. +This property may be set to a list of files to be placed in the +Resources directory inside the framework folder. On non-Apple +platforms these files may be installed using the RESOURCE option to +the install(TARGETS) command. diff --git a/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst b/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst new file mode 100644 index 0000000000..e92ab86aff --- /dev/null +++ b/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_COMPILE +------------------- + +Specify a launcher for compile rules. + +See the global property of the same name for details. This overrides +the global and directory property for a target. diff --git a/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst b/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst new file mode 100644 index 0000000000..2db03177f8 --- /dev/null +++ b/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_CUSTOM +------------------ + +Specify a launcher for custom rules. + +See the global property of the same name for details. This overrides +the global and directory property for a target. diff --git a/Help/prop_tgt/RULE_LAUNCH_LINK.rst b/Help/prop_tgt/RULE_LAUNCH_LINK.rst new file mode 100644 index 0000000000..f330033678 --- /dev/null +++ b/Help/prop_tgt/RULE_LAUNCH_LINK.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_LINK +---------------- + +Specify a launcher for link rules. + +See the global property of the same name for details. This overrides +the global and directory property for a target. diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000000..2aff5ebdd9 --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst @@ -0,0 +1,18 @@ +RUNTIME_OUTPUT_DIRECTORY +------------------------ + +Output directory in which to build RUNTIME target files. + +This property specifies the directory into which runtime target files +should be built. Multi-configuration generators (VS, Xcode) append a +per-configuration subdirectory to the specified directory. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. This +property is initialized by the value of the variable +CMAKE_RUNTIME_OUTPUT_DIRECTORY if it is set when a target is created. diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000000..10be6cf0cd --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,11 @@ +RUNTIME_OUTPUT_DIRECTORY_<CONFIG> +--------------------------------- + +Per-configuration output directory for RUNTIME target files. + +This is a per-configuration version of RUNTIME_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_RUNTIME_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst b/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst new file mode 100644 index 0000000000..b62d887c2e --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst @@ -0,0 +1,15 @@ +RUNTIME_OUTPUT_NAME +------------------- + +Output name for RUNTIME target files. + +This property specifies the base name for runtime target files. It +overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. There are +three kinds of target files that may be built: archive, library, and +runtime. Executables are always treated as runtime targets. Static +libraries are always treated as archive targets. Module libraries are +always treated as library targets. For non-DLL platforms shared +libraries are treated as library targets. For DLL platforms the DLL +part of a shared library is treated as a runtime target and the +corresponding import library is treated as an archive target. All +Windows-based systems including Cygwin are DLL platforms. diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000000..f9029e5d4e --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +RUNTIME_OUTPUT_NAME_<CONFIG> +---------------------------- + +Per-configuration output name for RUNTIME target files. + +This is the configuration-specific version of RUNTIME_OUTPUT_NAME. diff --git a/Help/prop_tgt/SKIP_BUILD_RPATH.rst b/Help/prop_tgt/SKIP_BUILD_RPATH.rst new file mode 100644 index 0000000000..a91fa9ca39 --- /dev/null +++ b/Help/prop_tgt/SKIP_BUILD_RPATH.rst @@ -0,0 +1,9 @@ +SKIP_BUILD_RPATH +---------------- + +Should rpaths be used for the build tree. + +SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic +generation of an rpath allowing the target to run from the build tree. +This property is initialized by the value of the variable +CMAKE_SKIP_BUILD_RPATH if it is set when a target is created. diff --git a/Help/prop_tgt/SOURCES.rst b/Help/prop_tgt/SOURCES.rst new file mode 100644 index 0000000000..833b65a6e7 --- /dev/null +++ b/Help/prop_tgt/SOURCES.rst @@ -0,0 +1,7 @@ +SOURCES +------- + +Source names specified for a target. + +Read-only list of sources specified for a target. The names returned +are suitable for passing to the set_source_files_properties command. diff --git a/Help/prop_tgt/SOVERSION.rst b/Help/prop_tgt/SOVERSION.rst new file mode 100644 index 0000000000..672ff23a8d --- /dev/null +++ b/Help/prop_tgt/SOVERSION.rst @@ -0,0 +1,14 @@ +SOVERSION +--------- + +What version number is this target. + +For shared libraries VERSION and SOVERSION can be used to specify the +build version and API version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. +SOVERSION is ignored if NO_SONAME property is set. For shared +libraries and executables on Windows the VERSION attribute is parsed +to extract a "major.minor" version number. These numbers are used as +the image version of the binary. diff --git a/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst b/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst new file mode 100644 index 0000000000..d3b2cd4788 --- /dev/null +++ b/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst @@ -0,0 +1,6 @@ +STATIC_LIBRARY_FLAGS +-------------------- + +Extra flags to use when linking static libraries. + +Extra flags to use when linking a static library. diff --git a/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst b/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst new file mode 100644 index 0000000000..cca353ddce --- /dev/null +++ b/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst @@ -0,0 +1,6 @@ +STATIC_LIBRARY_FLAGS_<CONFIG> +----------------------------- + +Per-configuration flags for creating a static library. + +This is the configuration-specific version of STATIC_LIBRARY_FLAGS. diff --git a/Help/prop_tgt/SUFFIX.rst b/Help/prop_tgt/SUFFIX.rst new file mode 100644 index 0000000000..70844be5cc --- /dev/null +++ b/Help/prop_tgt/SUFFIX.rst @@ -0,0 +1,7 @@ +SUFFIX +------ + +What comes after the target name. + +A target property that can be set to override the suffix (such as +".so" or ".exe") on the name of a library, module or executable. diff --git a/Help/prop_tgt/TYPE.rst b/Help/prop_tgt/TYPE.rst new file mode 100644 index 0000000000..1951d46bed --- /dev/null +++ b/Help/prop_tgt/TYPE.rst @@ -0,0 +1,8 @@ +TYPE +---- + +The type of the target. + +This read-only property can be used to test the type of the given +target. It will be one of STATIC_LIBRARY, MODULE_LIBRARY, +SHARED_LIBRARY, EXECUTABLE or one of the internal target types. diff --git a/Help/prop_tgt/VERSION.rst b/Help/prop_tgt/VERSION.rst new file mode 100644 index 0000000000..87f6c49766 --- /dev/null +++ b/Help/prop_tgt/VERSION.rst @@ -0,0 +1,16 @@ +VERSION +------- + +What version number is this target. + +For shared libraries VERSION and SOVERSION can be used to specify the +build version and API version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. For +executables VERSION can be used to specify the build version. When +building or installing appropriate symlinks are created if the +platform supports symlinks. For shared libraries and executables on +Windows the VERSION attribute is parsed to extract a "major.minor" +version number. These numbers are used as the image version of the +binary. diff --git a/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst b/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst new file mode 100644 index 0000000000..3754410a4b --- /dev/null +++ b/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst @@ -0,0 +1,11 @@ +VISIBILITY_INLINES_HIDDEN +------------------------- + +Whether to add a compile flag to hide symbols of inline functions + +The VISIBILITY_INLINES_HIDDEN property determines whether a flag for +hiding symbols for inline functions. the value passed used in a +visibility related compile option, such as -fvisibility=. This +property only has an affect for libraries and executables with +exports. This property is initialized by the value of the variable +CMAKE_VISIBILITY_INLINES_HIDDEN if it is set when a target is created. diff --git a/Help/prop_tgt/VS_DOTNET_REFERENCES.rst b/Help/prop_tgt/VS_DOTNET_REFERENCES.rst new file mode 100644 index 0000000000..a661ad926a --- /dev/null +++ b/Help/prop_tgt/VS_DOTNET_REFERENCES.rst @@ -0,0 +1,7 @@ +VS_DOTNET_REFERENCES +-------------------- + +Visual Studio managed project .NET references + +Adds one or more semicolon-delimited .NET references to a generated +Visual Studio project. For example, "System;System.Windows.Forms". diff --git a/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst b/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst new file mode 100644 index 0000000000..829d696d57 --- /dev/null +++ b/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst @@ -0,0 +1,7 @@ +VS_DOTNET_TARGET_FRAMEWORK_VERSION +---------------------------------- + +Specify the .NET target framework version. + +Used to specify the .NET target framework version for C++/CLI. For +example, "v4.5". diff --git a/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst b/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst new file mode 100644 index 0000000000..072475fa18 --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst @@ -0,0 +1,9 @@ +VS_GLOBAL_KEYWORD +----------------- + +Visual Studio project keyword. + +Sets the "keyword" attribute for a generated Visual Studio project. +Defaults to "Win32Proj". You may wish to override this value with +"ManagedCProj", for example, in a Visual Studio managed C++ unit test +project. diff --git a/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst b/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst new file mode 100644 index 0000000000..f4d9efc8eb --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst @@ -0,0 +1,15 @@ +VS_GLOBAL_PROJECT_TYPES +----------------------- + +Visual Studio project type(s). + +Can be set to one or more UUIDs recognized by Visual Studio to +indicate the type of project. This value is copied verbatim into the +generated project file. Example for a managed C++ unit testing +project: + +:: + + {3AC096D0-A1C2-E12C-1390-A8335801FDAB};{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942} + +UUIDs are semicolon-delimited. diff --git a/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst b/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst new file mode 100644 index 0000000000..a23c54005e --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst @@ -0,0 +1,7 @@ +VS_GLOBAL_ROOTNAMESPACE +----------------------- + +Visual Studio project root namespace. + +Sets the "RootNamespace" attribute for a generated Visual Studio +project. The attribute will be generated only if this is set. diff --git a/Help/prop_tgt/VS_GLOBAL_variable.rst b/Help/prop_tgt/VS_GLOBAL_variable.rst new file mode 100644 index 0000000000..56b8021bef --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_variable.rst @@ -0,0 +1,10 @@ +VS_GLOBAL_<variable> +-------------------- + +Visual Studio project-specific global variable. + +Tell the Visual Studio generator to set the global variable +'<variable>' to a given value in the generated Visual Studio project. +Ignored on other generators. Qt integration works better if +VS_GLOBAL_QtVersion is set to the version FindQt4.cmake found. For +example, "4.7.3" diff --git a/Help/prop_tgt/VS_KEYWORD.rst b/Help/prop_tgt/VS_KEYWORD.rst new file mode 100644 index 0000000000..aa8e206227 --- /dev/null +++ b/Help/prop_tgt/VS_KEYWORD.rst @@ -0,0 +1,7 @@ +VS_KEYWORD +---------- + +Visual Studio project keyword. + +Can be set to change the visual studio keyword, for example Qt +integration works better if this is set to Qt4VSv1.0. diff --git a/Help/prop_tgt/VS_SCC_AUXPATH.rst b/Help/prop_tgt/VS_SCC_AUXPATH.rst new file mode 100644 index 0000000000..054f59e3ad --- /dev/null +++ b/Help/prop_tgt/VS_SCC_AUXPATH.rst @@ -0,0 +1,7 @@ +VS_SCC_AUXPATH +-------------- + +Visual Studio Source Code Control Aux Path. + +Can be set to change the visual studio source code control auxpath +property. diff --git a/Help/prop_tgt/VS_SCC_LOCALPATH.rst b/Help/prop_tgt/VS_SCC_LOCALPATH.rst new file mode 100644 index 0000000000..b5b7721c5e --- /dev/null +++ b/Help/prop_tgt/VS_SCC_LOCALPATH.rst @@ -0,0 +1,7 @@ +VS_SCC_LOCALPATH +---------------- + +Visual Studio Source Code Control Local Path. + +Can be set to change the visual studio source code control local path +property. diff --git a/Help/prop_tgt/VS_SCC_PROJECTNAME.rst b/Help/prop_tgt/VS_SCC_PROJECTNAME.rst new file mode 100644 index 0000000000..6d7f628d92 --- /dev/null +++ b/Help/prop_tgt/VS_SCC_PROJECTNAME.rst @@ -0,0 +1,7 @@ +VS_SCC_PROJECTNAME +------------------ + +Visual Studio Source Code Control Project. + +Can be set to change the visual studio source code control project +name property. diff --git a/Help/prop_tgt/VS_SCC_PROVIDER.rst b/Help/prop_tgt/VS_SCC_PROVIDER.rst new file mode 100644 index 0000000000..80475af1f0 --- /dev/null +++ b/Help/prop_tgt/VS_SCC_PROVIDER.rst @@ -0,0 +1,7 @@ +VS_SCC_PROVIDER +--------------- + +Visual Studio Source Code Control Provider. + +Can be set to change the visual studio source code control provider +property. diff --git a/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst b/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst new file mode 100644 index 0000000000..cc6fb16b07 --- /dev/null +++ b/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst @@ -0,0 +1,6 @@ +VS_WINRT_EXTENSIONS +------------------- + +Visual Studio project C++/CX language extensions for Windows Runtime + +Can be set to enable C++/CX language extensions. diff --git a/Help/prop_tgt/VS_WINRT_REFERENCES.rst b/Help/prop_tgt/VS_WINRT_REFERENCES.rst new file mode 100644 index 0000000000..af98b2f7b7 --- /dev/null +++ b/Help/prop_tgt/VS_WINRT_REFERENCES.rst @@ -0,0 +1,7 @@ +VS_WINRT_REFERENCES +------------------- + +Visual Studio project Windows Runtime Metadata references + +Adds one or more semicolon-delimited WinRT references to a generated +Visual Studio project. For example, "Windows;Windows.UI.Core". diff --git a/Help/prop_tgt/WIN32_EXECUTABLE.rst b/Help/prop_tgt/WIN32_EXECUTABLE.rst new file mode 100644 index 0000000000..336d5f7f38 --- /dev/null +++ b/Help/prop_tgt/WIN32_EXECUTABLE.rst @@ -0,0 +1,12 @@ +WIN32_EXECUTABLE +---------------- + +Build an executable with a WinMain entry point on windows. + +When this property is set to true the executable when linked on +Windows will be created with a WinMain() entry point instead of just +main(). This makes it a GUI executable instead of a console +application. See the CMAKE_MFC_FLAG variable documentation to +configure use of MFC for WinMain executables. This property is +initialized by the value of the variable CMAKE_WIN32_EXECUTABLE if it +is set when a target is created. diff --git a/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst b/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst new file mode 100644 index 0000000000..0be313c866 --- /dev/null +++ b/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst @@ -0,0 +1,7 @@ +XCODE_ATTRIBUTE_<an-attribute> +------------------------------ + +Set Xcode target attributes directly. + +Tell the Xcode generator to set '<an-attribute>' to a given value in +the generated Xcode project. Ignored on other generators. |