| CMAKE-PROPERTIES(7) | CMake | CMAKE-PROPERTIES(7) |
cmake-properties - CMake Properties Reference
Allow duplicate custom targets to be created.
Normally CMake requires that all targets built in a project have globally unique logical names (see policy CMP0002). This is necessary to generate meaningful project file names in Xcode and VS IDE generators. It also allows the target names to be referenced unambiguously.
Makefile generators are capable of supporting duplicate custom target names. For projects that care only about Makefile generators and do not wish to support Xcode or VS IDE generators, one may set this property to true to allow duplicate custom targets. The property allows multiple add_custom_target command calls in different directories to specify the same target name. However, setting this property will cause non-Makefile generators to produce an error and refuse to generate the project.
Name of the source_group() for AUTOMOC and AUTORCC generated files.
Files generated by AUTOMOC and AUTORCC are not always known at configure time and therefore can’t be passed to source_group(). AUTOGEN_SOURCE_GROUP an be used instead to generate or select a source group for AUTOMOC and AUTORCC generated files.
For AUTOMOC and AUTORCC specific overrides see AUTOMOC_SOURCE_GROUP and AUTORCC_SOURCE_GROUP respectively.
Name of FOLDER for *_autogen targets that are added automatically by CMake for targets for which AUTOMOC is enabled.
If not set, CMake uses the FOLDER property of the parent target as a default value for this property. See also the documentation for the FOLDER target property and the AUTOMOC target property.
Name of the source_group() for AUTOMOC generated files.
When set this is used instead of AUTOGEN_SOURCE_GROUP for files generated by AUTOMOC.
Name of FOLDER for *_autogen targets that are added automatically by CMake for targets for which AUTOMOC is enabled.
This property is obsolete. Use AUTOGEN_TARGETS_FOLDER instead.
If not set, CMake uses the FOLDER property of the parent target as a default value for this property. See also the documentation for the FOLDER target property and the AUTOMOC target property.
Name of the source_group() for AUTORCC generated files.
When set this is used instead of AUTOGEN_SOURCE_GROUP for files generated by AUTORCC.
List of C features known to this version of CMake.
The features listed in this global property may be known to be available to the C compiler. If the feature is available with the C compiler, it will be listed in the CMAKE_C_COMPILE_FEATURES variable.
The features listed here may be used with the target_compile_features() command. See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
The features known to this version of CMake are:
List of C++ features known to this version of CMake.
The features listed in this global property may be known to be available to the C++ compiler. If the feature is available with the C++ compiler, it will be listed in the CMAKE_CXX_COMPILE_FEATURES variable.
The features listed here may be used with the target_compile_features() command. See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
The features known to this version of CMake are:
Specify which configurations are for debugging.
The value must be a semi-colon separated list of configuration names. Currently this property is used only by the target_link_libraries() command. Additional uses may be defined in the future.
This property must be set at the top level of the project and before the first target_link_libraries() command invocation. If any entry in the list does not match a valid configuration for the project the behavior is undefined.
List of features which are disabled during the CMake run.
List of features which are disabled during the CMake run. By default it contains the names of all packages which were not found. This is determined using the <NAME>_FOUND variables. Packages which are searched QUIET are not listed. A project can add its own features to this list. This property is used by the macros in FeatureSummary.cmake.
List of features which are enabled during the CMake run.
List of features which are enabled during the CMake run. By default it contains the names of all packages which were found. This is determined using the <NAME>_FOUND variables. Packages which are searched QUIET are not listed. A project can add its own features to this list. This property is used by the macros in FeatureSummary.cmake.
Read-only property that contains the list of currently enabled languages
Set to list of currently enabled languages.
Whether the find_library() command should automatically search lib32 directories.
FIND_LIBRARY_USE_LIB32_PATHS is a boolean specifying whether the find_library() command should automatically search the lib32 variant of directories called lib in the search path when building 32-bit binaries.
See also the CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX variable.
Whether find_library() should automatically search lib64 directories.
FIND_LIBRARY_USE_LIB64_PATHS is a boolean specifying whether the find_library() command should automatically search the lib64 variant of directories called lib in the search path when building 64-bit binaries.
See also the CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX variable.
Whether the find_library() command should automatically search libx32 directories.
FIND_LIBRARY_USE_LIBX32_PATHS is a boolean specifying whether the find_library() command should automatically search the libx32 variant of directories called lib in the search path when building x32-abi binaries.
See also the CMAKE_FIND_LIBRARY_CUSTOM_LIB_SUFFIX variable.
Whether find_library() should find OpenBSD-style shared libraries.
This property is a boolean specifying whether the find_library() command should find shared libraries with OpenBSD-style versioned extension: “.so.<major>.<minor>”. The property is set to true on OpenBSD and false on other platforms.
Read-only property that is true on multi-configuration generators.
True when using a multi-configuration generator (such as Visual Studio Generators or Xcode). Multi-config generators use CMAKE_CONFIGURATION_TYPES as the set of configurations and ignore CMAKE_BUILD_TYPE.
Enable global target dependency graph debug mode.
CMake automatically analyzes the global inter-target dependency graph at the beginning of native build system generation. This property causes it to display details of its analysis to stderr.
Disallow global target dependency graph cycles.
CMake automatically analyzes the global inter-target dependency graph at the beginning of native build system generation. It reports an error if the dependency graph contains a cycle that does not consist of all STATIC library targets. This property tells CMake to disallow all cycles completely, even among static libraries.
Read-only property that is true during a try-compile configuration.
True when building a project inside a try_compile() or try_run() command.
List of packages which were found during the CMake run.
List of packages which were found during the CMake run. Whether a package has been found is determined using the <NAME>_FOUND variables.
List of packages which were not found during the CMake run.
List of packages which were not found during the CMake run. Whether a package has been found is determined using the <NAME>_FOUND variables.
Ninja only: List of available pools.
A pool is a named integer property and defines the maximum number of concurrent jobs which can be started by a rule assigned to the pool. The JOB_POOLS property is a semicolon-separated list of pairs using the syntax NAME=integer (without a space after the equality sign).
For instance:
set_property(GLOBAL PROPERTY JOB_POOLS two_jobs=2 ten_jobs=10)
Defined pools could be used globally by setting CMAKE_JOB_POOL_COMPILE and CMAKE_JOB_POOL_LINK or per target by setting the target properties JOB_POOL_COMPILE and JOB_POOL_LINK.
If not set, this property uses the value of the CMAKE_JOB_POOLS variable.
Build targets provided by CMake that are meant for individual interactive use, such as install, are placed in the console pool automatically.
Name of FOLDER for targets that are added automatically by CMake.
If not set, CMake uses “CMakePredefinedTargets” as a default value for this property. Targets such as INSTALL, PACKAGE and RUN_TESTS will be organized into this FOLDER. See also the documentation for the FOLDER target property.
List of natures to add to the generated Eclipse project file.
Eclipse projects specify language plugins by using natures. This property should be set to the unique identifier for a nature (which looks like a Java package name).
Also see the ECLIPSE_EXTRA_CPROJECT_CONTENTS property.
Additional contents to be inserted into the generated Eclipse cproject file.
The cproject file defines the CDT specific information. Some third party IDE’s are based on Eclipse with the addition of other information specific to that IDE. Through this property, it is possible to add this additional contents to the generated project. It is expected to contain valid XML.
Also see the ECLIPSE_EXTRA_NATURES property.
If set, report any undefined properties to this file.
If this property is set to a filename then when CMake runs it will report any properties or variables that were accessed but not defined into the filename specified in this property.
Specify a launcher for compile rules.
Makefile Generators and the Ninja generator prefix compiler commands with the given launcher command line. This is intended to allow launchers to intercept build problems with high granularity. Other generators ignore this property because their underlying build systems provide no hook to wrap individual commands with a launcher.
Specify a launcher for custom rules.
Makefile Generators and the Ninja generator prefix custom commands with the given launcher command line. This is intended to allow launchers to intercept build problems with high granularity. Other generators ignore this property because their underlying build systems provide no hook to wrap individual commands with a launcher.
Specify a launcher for link rules.
Makefile Generators and the Ninja generator prefix link and archive commands with the given launcher command line. This is intended to allow launchers to intercept build problems with high granularity. Other generators ignore this property because their underlying build systems provide no hook to wrap individual commands with a launcher.
Specify whether to report a message for each make rule.
This property specifies whether Makefile generators should add a progress message describing what each build rule does. If the property is not set the default is ON. Set the property to OFF to disable granular messages and report only as each target completes. This is intended to allow scripted builds to avoid the build time cost of detailed reports. If a CMAKE_RULE_MESSAGES cache entry exists its value initializes the value of this property. Non-Makefile generators currently ignore this property.
Set if shared libraries may be named like archives.
On AIX shared libraries may be named “lib<name>.a”. This property is set to true on such platforms.
Specify whether to report the completion of each target.
This property specifies whether Makefile Generators should add a progress message describing that each target has been completed. If the property is not set the default is ON. Set the property to OFF to disable target completion messages.
This option is intended to reduce build output when little or no work needs to be done to bring the build tree up to date.
If a CMAKE_TARGET_MESSAGES cache entry exists its value initializes the value of this property.
Non-Makefile generators currently ignore this property.
See the counterpart property RULE_MESSAGES to disable everything except for target completion messages.
Does the target platform support shared libraries.
TARGET_SUPPORTS_SHARED_LIBS is a boolean specifying whether the target platform supports shared libraries. Basically all current general general purpose OS do so, the exception are usually embedded systems with no or special OSs.
Use the FOLDER target property to organize targets into folders.
If not set, CMake treats this property as OFF by default. CMake generators that are capable of organizing into a hierarchy of folders use the values of the FOLDER target property to name those folders. See also the documentation for the FOLDER target property.
Control emission of EFFECTIVE_PLATFORM_NAME by the Xcode generator.
It is required for building the same target with multiple SDKs. A common use case is the parallel use of iphoneos and iphonesimulator SDKs.
Three different states possible that control when the Xcode generator emits the EFFECTIVE_PLATFORM_NAME variable:
NOTE:
Additional files to clean during the make clean stage.
A list of files that will be cleaned as a part of the “make clean” stage.
This read-only directory property reports absolute path to the binary directory corresponding to the source on which it is read.
This read-only directory property contains a ;-list of buildsystem targets added in the directory by calls to the add_library(), add_executable(), and add_custom_target() commands. The list does not include any Imported Targets or Alias Targets, but does include Interface Libraries. Each entry in the list is the logical name of a target, suitable to pass to the get_property() command TARGET option.
List of cache variables available in the current directory.
This read-only property specifies the list of CMake cache variables currently defined. It is intended for debugging purposes.
Set to true to tell Makefile Generators not to remove the outputs of custom commands for this directory during the make clean operation. This is ignored on other generators because it is not possible to implement.
Tell CMake about additional input files to the configuration process. If any named file is modified the build system will re-run CMake to re-configure the file and generate the build system again.
Specify files as a semicolon-separated list of paths. Relative paths are interpreted as relative to the current source directory.
Preprocessor definitions for compiling a directory’s sources.
This property specifies the list of options given so far to the add_compile_definitions() (or add_definitions()) command.
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 will be initialized in each directory by its value in the directory’s parent.
CMake will automatically drop some definitions that are not supported by the native build tool.
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.
Contents of COMPILE_DEFINITIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
The corresponding COMPILE_DEFINITIONS_<CONFIG> property may be set to specify per-configuration definitions. Generator expressions should be preferred instead of setting the alternative property.
List of options to pass to the compiler.
This property holds a ;-list of options given so far to the add_compile_options() command.
This property is used to initialize the COMPILE_OPTIONS target property when a target is created, which is used by the generators to set the options for the compiler.
Contents of COMPILE_OPTIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
For CMake 2.4 compatibility only. Use COMPILE_DEFINITIONS instead.
This read-only property specifies the list of flags given so far to the add_definitions() command. It is intended for debugging purposes. Use the COMPILE_DEFINITIONS directory property instead.
This built-in read-only property does not exist if policy CMP0059 is set to NEW.
Exclude the directory from the all target of its parent.
A property on a directory that indicates if its targets are excluded from the default build target. If it is not, then with a Makefile for example typing make will cause the targets to be built. The same concept applies to the default build of other generators.
Specify #include line transforms for dependencies in a directory.
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 all targets within a directory. The property value is initialized in each directory by its value in the directory’s parent.
List of preprocessor include file search directories.
This property specifies the list of directories given so far to the include_directories() command.
This property is used to populate the INCLUDE_DIRECTORIES target property, which is used by the generators to set the include directories for the compiler.
In addition to accepting values from that command, values may be set directly on any directory using the set_property() command, and can be set on the current directory using the set_directory_properties() command. A directory gets its initial value from its parent directory if it has one. The initial value of the INCLUDE_DIRECTORIES target property comes from the value of this property. Both directory and target property values are adjusted by calls to the include_directories() command. Calls to set_property() or set_directory_properties(), however, will update the directory property value without updating target property values. Therefore direct property updates must be made before calls to add_executable() or add_library() for targets they are meant to affect.
The target property values are used by the generators to set the include paths for the compiler.
Contents of INCLUDE_DIRECTORIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
Include file scanning regular expression.
This property specifies the regular expression used during dependency scanning to match include files that should be followed. See the include_regular_expression() command for a high-level interface to set this property.
Per-configuration interprocedural optimization for a directory.
This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. If set, this property overrides the generic property for the named configuration.
Enable interprocedural optimization for targets in a directory.
If set to true, enables interprocedural optimizations if they are known to be supported by the compiler.
Specify a list of text labels associated with a directory and all of its subdirectories. This is equivalent to setting the LABELS target property and the LABELS test property on all targets and tests in the current directory and subdirectories. Note: Launchers must enabled to propagate labels to targets.
The CMAKE_DIRECTORY_LABELS variable can be used to initialize this property.
The list is reported in dashboard submissions.
List of linker search directories.
This property holds a ;-list of directories and is typically populated using the link_directories() command. It gets its initial value from its parent directory, if it has one.
The directory property is used to initialize the LINK_DIRECTORIES target property when a target is created. That target property is used by the generators to set the library search directories for the linker.
Contents of LINK_DIRECTORIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
List of options to use for the link step of shared library, module and executable targets.
This property holds a ;-list of options given so far to the add_link_options() command.
This property is used to initialize the LINK_OPTIONS target property when a target is created, which is used by the generators to set the options for the compiler.
Contents of LINK_OPTIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
The current stack of listfiles being processed.
This property is mainly useful when trying to debug errors in your CMake scripts. It returns a list of what list files are currently being processed, in order. So if one listfile does an include() command then that is effectively pushing the included listfile onto the stack.
List of macro commands available in the current directory.
This read-only property specifies the list of CMake macros currently defined. It is intended for debugging purposes. See the macro command.
Source directory that added current subdirectory.
This read-only property specifies the source directory that added the current source directory as a subdirectory of the build. In the top-level directory the value is the empty-string.
Specify a launcher for compile rules.
See the global property of the same name for details. This overrides the global property for a directory.
Specify a launcher for custom rules.
See the global property of the same name for details. This overrides the global property for a directory.
Specify a launcher for link rules.
See the global property of the same name for details. This overrides the global property for a directory.
This read-only directory property reports absolute path to the source directory on which it is read.
This read-only directory property contains a ;-list of subdirectories processed so far by the add_subdirectory() or subdirs() commands. Each entry is the absolute path to the source directory (containing the CMakeLists.txt file). This is suitable to pass to the get_property() command DIRECTORY option.
NOTE:
List of tests.
This read-only property holds a ;-list of tests defined so far, in the current directory, by the add_test() command.
A list of cmake files that will be included when ctest is run.
If you specify TEST_INCLUDE_FILES, those files will be included and processed when ctest is run on the directory.
List of variables defined in the current directory.
This read-only property specifies the list of CMake variables currently defined. It is intended for debugging purposes.
Specify a postSolution global section in Visual Studio.
Setting a property like this generates an entry of the following form in the solution file:
GlobalSection(<section>) = postSolution
<contents based on property value> EndGlobalSection
The property must be set to a semicolon-separated list of key=value pairs. Each such pair will be transformed into an entry in the solution global section. Whitespace around key and value is ignored. List elements which do not contain an equal sign are skipped.
This property only works for Visual Studio 9 and above; it is ignored on other generators. The property only applies when set on a directory whose CMakeLists.txt contains a project() command.
Note that CMake generates postSolution sections ExtensibilityGlobals and ExtensibilityAddIns by default. If you set the corresponding property, it will override the default section. For example, setting VS_GLOBAL_SECTION_POST_ExtensibilityGlobals will override the default contents of the ExtensibilityGlobals section, while keeping ExtensibilityAddIns on its default. However, CMake will always add a SolutionGuid to the ExtensibilityGlobals section if it is not specified explicitly.
Specify a preSolution global section in Visual Studio.
Setting a property like this generates an entry of the following form in the solution file:
GlobalSection(<section>) = preSolution
<contents based on property value> EndGlobalSection
The property must be set to a semicolon-separated list of key=value pairs. Each such pair will be transformed into an entry in the solution global section. Whitespace around key and value is ignored. List elements which do not contain an equal sign are skipped.
This property only works for Visual Studio 9 and above; it is ignored on other generators. The property only applies when set on a directory whose CMakeLists.txt contains a project() command.
Specify the default startup project in a Visual Studio solution.
The Visual Studio Generators create a .sln file for each directory whose CMakeLists.txt file calls the project() command. Set this property in the same directory as a project() command call (e.g. in the top-level CMakeLists.txt file) to specify the default startup project for the correpsonding solution file.
The property must be set to the name of an existing target. This will cause that project to be listed first in the generated solution file causing Visual Studio to make it the startup project if the solution has never been opened before.
If this property is not specified, then the ALL_BUILD project will be the default.
Name of target aliased by this target.
If this is an Alias Target, this property contains the name of the target aliased.
Set the additional options for Android Ant build system. This is a string value containing all command line options for the Ant build. This property is initialized by the value of the CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS variable if it is set when a target is created.
When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property sets the Android target API version (e.g. 15). The version number must be a positive decimal integer. This property is initialized by the value of the CMAKE_ANDROID_API variable if it is set when a target is created.
Set the Android MIN API version (e.g. 9). The version number must be a positive decimal integer. This property is initialized by the value of the CMAKE_ANDROID_API_MIN variable if it is set when a target is created. Native code builds using this API version.
When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property sets the Android target architecture.
This is a string property that could be set to the one of the following values:
This property is initialized by the value of the CMAKE_ANDROID_ARCH variable if it is set when a target is created.
Set the Android assets directories to copy into the main assets folder before build. This a string property that contains the directory paths separated by semicolon. This property is initialized by the value of the CMAKE_ANDROID_ASSETS_DIRECTORIES variable if it is set when a target is created.
When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property specifies whether to build an executable as an application package on Android.
When this property is set to true the executable when built for Android will be created as an application package. This property is initialized by the value of the CMAKE_ANDROID_GUI variable if it is set when a target is created.
Add the AndroidManifest.xml source file explicitly to the target add_executable() command invocation to specify the root directory of the application package source.
Set the Android property that specifies JAR dependencies. This is a string value property. This property is initialized by the value of the CMAKE_ANDROID_JAR_DEPENDENCIES variable if it is set when a target is created.
Set the Android property that specifies directories to search for the JAR libraries.
This a string property that contains the directory paths separated by semicolons. This property is initialized by the value of the CMAKE_ANDROID_JAR_DIRECTORIES variable if it is set when a target is created.
Contents of ANDROID_JAR_DIRECTORIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions.
Set the Android property that defines the Java source code root directories. This a string property that contains the directory paths separated by semicolon. This property is initialized by the value of the CMAKE_ANDROID_JAVA_SOURCE_DIR variable if it is set when a target is created.
Set the Android property that specifies the .so dependencies. This is a string property.
This property is initialized by the value of the CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES variable if it is set when a target is created.
Contents of ANDROID_NATIVE_LIB_DEPENDENCIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions.
Set the Android property that specifies directories to search for the
This a string property that contains the directory paths separated by semicolons.
This property is initialized by the value of the CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES variable if it is set when a target is created.
Contents of ANDROID_NATIVE_LIB_DIRECTORIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions.
Set the Android property that defines the maximum number of a parallel Android NDK compiler processes (e.g. 4). This property is initialized by the value of the CMAKE_ANDROID_PROCESS_MAX variable if it is set when a target is created.
When this property is set to true that enables the ProGuard tool to shrink, optimize, and obfuscate the code by removing unused code and renaming classes, fields, and methods with semantically obscure names. This property is initialized by the value of the CMAKE_ANDROID_PROGUARD variable if it is set when a target is created.
Set the Android property that specifies the location of the ProGuard config file. Leave empty to use the default one. This a string property that contains the path to ProGuard config file. This property is initialized by the value of the CMAKE_ANDROID_PROGUARD_CONFIG_PATH variable if it is set when a target is created.
Set the Android property that states the location of the secure properties file. This is a string property that contains the file path. This property is initialized by the value of the CMAKE_ANDROID_SECURE_PROPS_PATH variable if it is set when a target is created.
Set the Android property that defines whether or not to skip the Ant build step. This is a boolean property initialized by the value of the CMAKE_ANDROID_SKIP_ANT_STEP variable if it is set when a target is created.
When Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition, this property specifies the type of STL support for the project. This is a string property that could set to the one of the following values:
This property is initialized by the value of the CMAKE_ANDROID_STL_TYPE variable if it is set when a target is created.
Per-configuration output directory for ARCHIVE target files.
This is a per-configuration version of the ARCHIVE_OUTPUT_DIRECTORY target property, 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 CMAKE_ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.
Contents of ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> may use generator expressions.
Output directory in which to build ARCHIVE target files.
This property specifies the directory into which archive target files should be built. The property value may use generator expressions. Multi-configuration generators (VS, Xcode) append a per-configuration subdirectory to the specified directory unless a generator expression is used.
This property is initialized by the value of the variable CMAKE_ARCHIVE_OUTPUT_DIRECTORY if it is set when a target is created.
See also the ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> target property.
Per-configuration output name for ARCHIVE target files.
This is the configuration-specific version of the ARCHIVE_OUTPUT_NAME target property.
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.
See also the ARCHIVE_OUTPUT_NAME_<CONFIG> target property.
Directory where AUTOMOC, AUTOUIC and AUTORCC generate files for the target.
The directory is created on demand and automatically added to the ADDITIONAL_MAKE_CLEAN_FILES.
When unset or empty the directory <dir>/<target-name>_autogen is used where <dir> is CMAKE_CURRENT_BINARY_DIR and <target-name> is NAME.
By default AUTOGEN_BUILD_DIR is unset.
See the cmake-qt(7) manual for more information on using CMake with Qt.
Number of parallel moc or uic processes to start when using AUTOMOC and AUTOUIC.
The custom <origin>_autogen target starts a number of threads of which each one parses a source file and on demand starts a moc or uic process. AUTOGEN_PARALLEL controls how many parallel threads (and therefore moc or uic processes) are started.
By default AUTOGEN_PARALLEL is initialized from CMAKE_AUTOGEN_PARALLEL.
See the cmake-qt(7) manual for more information on using CMake with Qt.
Target dependencies of the corresponding _autogen target.
Targets which have their AUTOMOC or AUTOUIC property ON have a corresponding _autogen target which is used to auto generate moc and uic files. As this _autogen target is created at generate-time, it is not possible to define dependencies of it, such as to create inputs for the moc or uic executable.
The AUTOGEN_TARGET_DEPENDS target property can be set instead to a list of dependencies of the _autogen target. Dependencies can be target names or file names.
See the cmake-qt(7) manual for more information on using CMake with Qt.
If AUTOMOC or AUTOUIC depends on a file that is either
it must added to AUTOGEN_TARGET_DEPENDS.
Boolean value used by AUTOMOC to determine if the compiler pre definitions file moc_predefs.h should be generated.
CMake generates a moc_predefs.h file with compiler pre definitions from the output of the command defined in CMAKE_CXX_COMPILER_PREDEFINES_COMMAND when
The moc_predefs.h file, which is generated in AUTOGEN_BUILD_DIR, is passed to moc as the argument to the --include option.
By default AUTOMOC_COMPILER_PREDEFINES is initialized from CMAKE_AUTOMOC_COMPILER_PREDEFINES, which is ON by default.
See the cmake-qt(7) manual for more information on using CMake with Qt.
Filter definitions used by AUTOMOC to extract file names from a source file that are registered as additional dependencies for the moc file of the source file.
Filters are defined as KEYWORD;REGULAR_EXPRESSION pairs. First the file content is searched for KEYWORD. If it is found at least once, then file names are extracted by successively searching for REGULAR_EXPRESSION and taking the first match group.
The file name found in the first match group is searched for
If any of the extracted files changes, then the moc file for the source file gets rebuilt even when the source file itself doesn’t change.
If any of the extracted files is GENERATED or if it is not in the target’s sources, then it might be necessary to add it to the _autogen target dependencies. See AUTOGEN_TARGET_DEPENDS for reference.
By default AUTOMOC_DEPEND_FILTERS is initialized from CMAKE_AUTOMOC_DEPEND_FILTERS, which is empty by default.
See the cmake-qt(7) manual for more information on using CMake with Qt.
A header file my_class.hpp uses a custom macro JSON_FILE_MACRO which is defined in an other header macros.hpp. We want the moc file of my_class.hpp to depend on the file name argument of JSON_FILE_MACRO:
// my_class.hpp
class My_Class : public QObject
{
Q_OBJECT
JSON_FILE_MACRO ( "info.json" )
...
};
In CMakeLists.txt we add a filter to CMAKE_AUTOMOC_DEPEND_FILTERS like this:
list( APPEND CMAKE_AUTOMOC_DEPEND_FILTERS
"JSON_FILE_MACRO"
"[\n][ \t]*JSON_FILE_MACRO[ \t]*\\([ \t]*\"([^\"]+)\"" )
We assume info.json is a plain (not GENERATED) file that is listed in the target’s source. Therefore we do not need to add it to AUTOGEN_TARGET_DEPENDS.
In the target my_target a header file complex_class.hpp uses a custom macro JSON_BASED_CLASS which is defined in an other header macros.hpp:
// macros.hpp
...
#define JSON_BASED_CLASS(name, json) \
class name : public QObject \
{ \
Q_OBJECT \
Q_PLUGIN_METADATA(IID "demo" FILE json) \
name() {} \
};
...
// complex_class.hpp #pragma once JSON_BASED_CLASS(Complex_Class, "meta.json") // end of file
Since complex_class.hpp doesn’t contain a Q_OBJECT macro it would be ignored by AUTOMOC. We change this by adding JSON_BASED_CLASS to CMAKE_AUTOMOC_MACRO_NAMES:
list(APPEND CMAKE_AUTOMOC_MACRO_NAMES "JSON_BASED_CLASS")
We want the moc file of complex_class.hpp to depend on meta.json. So we add a filter to CMAKE_AUTOMOC_DEPEND_FILTERS:
list(APPEND CMAKE_AUTOMOC_DEPEND_FILTERS
"JSON_BASED_CLASS"
"[\n^][ \t]*JSON_BASED_CLASS[ \t]*\\([^,]*,[ \t]*\"([^\"]+)\"" )
Additionally we assume meta.json is GENERATED which is why we have to add it to AUTOGEN_TARGET_DEPENDS:
set_property(TARGET my_target APPEND PROPERTY AUTOGEN_TARGET_DEPENDS "meta.json")
A ;-list list of macro names used by AUTOMOC to determine if a C++ file needs to be processed by moc.
This property is only used if the AUTOMOC property is ON for this target.
When running AUTOMOC, CMake searches for the strings listed in AUTOMOC_MACRO_NAMES in C++ source and header files. If any of the strings is found
then the file will be processed by moc.
By default AUTOMOC_MACRO_NAMES is initialized from CMAKE_AUTOMOC_MACRO_NAMES.
See the cmake-qt(7) manual for more information on using CMake with Qt.
In this case the Q_OBJECT macro is hidden inside another macro called CUSTOM_MACRO. To let CMake know that source files that contain CUSTOM_MACRO need to be moc processed, we call:
set_property(TARGET tgt APPEND PROPERTY AUTOMOC_MACRO_NAMES "CUSTOM_MACRO")
Additional options for moc when using AUTOMOC
This property is only used if the AUTOMOC property is ON 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.
See the cmake-qt(7) manual for more information on using CMake with Qt.
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 ON, CMake will scan the header and source files at build time and invoke moc accordingly.
This property is initialized by the value of the CMAKE_AUTOMOC variable 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 enabling the CMAKE_AUTOMOC_RELAXED_MODE variable 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 AUTOGEN_TARGETS_FOLDER can be used to group the automoc targets together in an IDE, e.g. in MSVS.
The global property AUTOGEN_SOURCE_GROUP can be used to group files generated by AUTOMOC together in an IDE, e.g. in MSVS.
Additional macro names to search for can be added to AUTOMOC_MACRO_NAMES.
Additional moc dependency file names can be extracted from source code by using AUTOMOC_DEPEND_FILTERS.
Compiler pre definitions for moc are written to a moc_predefs.h file which is controlled by AUTOMOC_COMPILER_PREDEFINES.
Source C++ files can be excluded from AUTOMOC processing by enabling SKIP_AUTOMOC or the broader SKIP_AUTOGEN.
The number of parallel moc processes to start can be modified by setting AUTOGEN_PARALLEL.
See the cmake-qt(7) manual for more information on using CMake with Qt.
Should the target be processed with autouic (for Qt projects).
AUTOUIC is a boolean specifying whether CMake will handle the Qt uic code generator automatically, i.e. without having to use the QT4_WRAP_UI() or QT5_WRAP_UI() macro. Currently Qt4 and Qt5 are supported.
When this property is ON, CMake will scan the source files at build time and invoke uic accordingly. If an #include statement like #include "ui_foo.h" is found in source.cpp, a foo.ui file is searched for first in the vicinity of source.cpp and afterwards in the optional AUTOUIC_SEARCH_PATHS of the target. uic is run on the foo.ui file to generate ui_foo.h in the directory <AUTOGEN_BUILD_DIR>/include, which is automatically added to the target’s INCLUDE_DIRECTORIES.
This property is initialized by the value of the CMAKE_AUTOUIC variable if it is set when a target is created.
Additional command line options for uic can be set via the AUTOUIC_OPTIONS source file property on the foo.ui file. The global property AUTOGEN_TARGETS_FOLDER can be used to group the autouic targets together in an IDE, e.g. in MSVS.
Source files can be excluded from AUTOUIC processing by enabling SKIP_AUTOUIC or the broader SKIP_AUTOGEN.
The number of parallel uic processes to start can be modified by setting AUTOGEN_PARALLEL.
See the cmake-qt(7) manual for more information on using CMake with Qt.
Additional options for uic when using AUTOUIC
This property holds additional command line options which will be used when uic is executed during the build via AUTOUIC, i.e. it is equivalent to the optional OPTIONS argument of the qt4_wrap_ui() macro.
By default it is empty.
This property is initialized by the value of the CMAKE_AUTOUIC_OPTIONS variable if it is set when a target is created.
The options set on the target may be overridden by AUTOUIC_OPTIONS set on the .ui source file.
This property may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions.
See the cmake-qt(7) manual for more information on using CMake with Qt.
# ... set_property(TARGET tgt PROPERTY AUTOUIC_OPTIONS "--no-protection") # ...
Search path list used by AUTOUIC to find included .ui files.
This property is initialized by the value of the CMAKE_AUTOUIC_SEARCH_PATHS variable if it is set when a target is created. Otherwise it is empty.
See the cmake-qt(7) manual for more information on using CMake with Qt.
Should the target be processed with autorcc (for Qt projects).
AUTORCC is a boolean specifying whether CMake will handle the Qt rcc code generator automatically, i.e. without having to use the QT4_ADD_RESOURCES() or QT5_ADD_RESOURCES() macro. Currently Qt4 and Qt5 are supported.
When this property is ON, CMake will handle .qrc files added as target sources at build time and invoke rcc accordingly. This property is initialized by the value of the CMAKE_AUTORCC variable if it is set when a target is created.
By default AUTORCC is processed inside a custom command. If the .qrc file is GENERATED though, a custom target is used instead.
Additional command line options for rcc can be set via the AUTORCC_OPTIONS source file property on the .qrc file.
The global property AUTOGEN_TARGETS_FOLDER can be used to group the autorcc targets together in an IDE, e.g. in MSVS.
The global property AUTOGEN_SOURCE_GROUP can be used to group files generated by AUTORCC together in an IDE, e.g. in MSVS.
When there are multiple .qrc files with the same name, CMake will generate unspecified unique names for rcc. Therefore if Q_INIT_RESOURCE() or Q_CLEANUP_RESOURCE() need to be used the .qrc file name must be unique.
Source files can be excluded from AUTORCC processing by enabling SKIP_AUTORCC or the broader SKIP_AUTOGEN.
See the cmake-qt(7) manual for more information on using CMake with Qt.
Additional options for rcc when using AUTORCC
This property holds additional command line options which will be used when rcc is executed during the build via AUTORCC, i.e. it is equivalent to the optional OPTIONS argument of the qt4_add_resources() macro.
By default it is empty.
This property is initialized by the value of the CMAKE_AUTORCC_OPTIONS variable if it is set when a target is created.
The options set on the target may be overridden by AUTORCC_OPTIONS set on the .qrc source file.
See the cmake-qt(7) manual for more information on using CMake with Qt.
# ... set_property(TARGET tgt PROPERTY AUTORCC_OPTIONS "--compress;9") # ...
This read-only property reports the value of the CMAKE_CURRENT_BINARY_DIR variable in the directory in which the target was defined.
A ;-list specifying runtime path (RPATH) entries to add to binaries linked in the build tree (for platforms that support it). The entries will not be used for binaries in the install tree. See also the INSTALL_RPATH target property.
This property is initialized by the value of the variable CMAKE_BUILD_RPATH if it is set when a target is created.
BUILD_WITH_INSTALL_NAME_DIR is a boolean specifying whether the macOS install_name of a target in the build tree uses the directory given by INSTALL_NAME_DIR. This setting only applies to targets on macOS.
This property is initialized by the value of the variable CMAKE_BUILD_WITH_INSTALL_NAME_DIR if it is set when a target is created.
If this property is not set and policy CMP0068 is not NEW, the value of BUILD_WITH_INSTALL_RPATH is used in its place.
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 CMAKE_BUILD_WITH_INSTALL_RPATH variable if it is set when a target is created.
If policy CMP0068 is not NEW, this property also controls use of INSTALL_NAME_DIR in the build tree on macOS. Either way, the BUILD_WITH_INSTALL_NAME_DIR target property takes precedence.
The file extension used to name a BUNDLE, a FRAMEWORK, or a MACOSX_BUNDLE target on the macOS and iOS.
The default value is bundle, framework, or app for the respective target types.
This target is a CFBundle on the macOS.
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.
Boolean specifying whether compiler specific extensions are requested.
This property specifies whether compiler specific extensions should be used. For some compilers, this results in adding a flag such as -std=gnu11 instead of -std=c11 to the compile line. This property is ON by default. The basic C standard level is controlled by the C_STANDARD target property.
See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
This property is initialized by the value of the CMAKE_C_EXTENSIONS variable if it is set when a target is created.
The C standard whose features are requested to build this target.
This property specifies the C standard whose features are requested to build this target. For some compilers, this results in adding a flag such as -std=gnu11 to the compile line. For compilers that have no notion of a standard level, such as Microsoft Visual C++ before 2015 Update 3, this has no effect.
Supported values are 90, 99 and 11.
If the value requested does not result in a compile flag being added for the compiler in use, a previous standard flag will be added instead. This means that using:
set_property(TARGET tgt PROPERTY C_STANDARD 11)
with a compiler which does not support -std=gnu11 or an equivalent flag will not result in an error or warning, but will instead add the -std=gnu99 or -std=gnu90 flag if supported. This “decay” behavior may be controlled with the C_STANDARD_REQUIRED target property. Additionally, the C_EXTENSIONS target property may be used to control whether compiler-specific extensions are enabled on a per-target basis.
See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
This property is initialized by the value of the CMAKE_C_STANDARD variable if it is set when a target is created.
Boolean describing whether the value of C_STANDARD is a requirement.
If this property is set to ON, then the value of the C_STANDARD target property is treated as a requirement. If this property is OFF or unset, the C_STANDARD target property is treated as optional and may “decay” to a previous standard if the requested is not available. For compilers that have no notion of a standard level, such as MSVC, this has no effect.
See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
This property is initialized by the value of the CMAKE_C_STANDARD_REQUIRED variable if it is set when a target is created.
By setting this target property, the target is configured to build with C++/CLI support.
The Visual Studio generator defines the clr parameter depending on the value of COMMON_LANGUAGE_RUNTIME:
Supported values: "", "pure", "safe"
This property is only evaluated Visual Studio Generators for VS 2010 and above.
To be able to build managed C++ targets with VS 2017 and above the component C++/CLI support must be installed, which may not be done by default.
See also IMPORTED_COMMON_LANGUAGE_RUNTIME
Properties which must be compatible with their link interface
The COMPATIBLE_INTERFACE_BOOL property may contain a list of properties for this target which must be consistent when evaluated as a boolean with the INTERFACE variant of the property in 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 depender.
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 specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.
Properties whose maximum value from the link interface will be used.
The COMPATIBLE_INTERFACE_NUMBER_MAX property may contain a list of properties for this target whose maximum value may be read at generate time when evaluated in the INTERFACE variant of the property in 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 will be compared with each other and with the FOO property in the depender. When reading the FOO property at generate time, the maximum value will be returned. If the property is not set, then it is ignored.
Note that for each dependee, the set of properties specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.
Properties whose maximum value from the link interface will be used.
The COMPATIBLE_INTERFACE_NUMBER_MIN property may contain a list of properties for this target whose minimum value may be read at generate time when evaluated in the INTERFACE variant of the property 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 will be compared with each other and with the FOO property in the depender. When reading the FOO property at generate time, the minimum value will be returned. If the property is not set, then it is ignored.
Note that for each dependee, the set of properties specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.
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 variant of the property 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 depender. If the property is not set, then it is ignored.
Note that for each dependee, the set of properties specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.
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).
CMake will automatically drop some definitions that are not supported by the native build tool.
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.
Contents of COMPILE_DEFINITIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
The corresponding COMPILE_DEFINITIONS_<CONFIG> property may be set to specify per-configuration definitions. Generator expressions should be preferred instead of setting the alternative property.
Compiler features enabled for this target.
The list of features in this property are a subset of the features listed in the CMAKE_CXX_COMPILE_FEATURES variable.
Contents of COMPILE_FEATURES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
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.
List of options to pass to the compiler.
This property holds a ;-list of options specified so far for its target. Use the target_compile_options() command to append more options.
This property is initialized by the COMPILE_OPTIONS directory property when a target is created, and is used by the generators to set the options for the compiler.
Contents of COMPILE_OPTIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
Output name for the MS debug symbol .pdb file generated by the compiler while building source files.
This property specifies the base name for the debug symbols file. If not set, the default is unspecified.
NOTE:
Per-configuration output name for the MS debug symbol .pdb file generated by the compiler while building source files.
This is the configuration-specific version of COMPILE_PDB_NAME.
NOTE:
Output directory for the MS debug symbol .pdb file generated by the compiler while building source files.
This property specifies the directory into which the MS debug symbols will be placed by the compiler. This property is initialized by the value of the CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY variable if it is set when a target is created.
NOTE:
Per-configuration output directory for the MS debug symbol .pdb file generated by the compiler while building source files.
This is a per-configuration version of COMPILE_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 CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.
NOTE:
Old per-configuration target file base name. Use OUTPUT_NAME_<CONFIG> instead.
This is a configuration-specific version of the OUTPUT_NAME target property.
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.
Use the given emulator to run executables created when crosscompiling. This command will be added as a prefix to add_test(), add_custom_command(), and add_custom_target() commands for built target system executables.
This property is initialized by the value of the CMAKE_CROSSCOMPILING_EMULATOR variable if it is set when a target is created.
Compile CUDA sources to .ptx files instead of .obj files within Object Libraries.
For example:
add_library(myptx OBJECT a.cu b.cu) set_property(TARGET myptx PROPERTY CUDA_PTX_COMPILATION ON)
CUDA only: Enables separate compilation of device code
If set this will enable separable compilation for all CUDA files for the given target.
For instance:
set_property(TARGET myexe PROPERTY CUDA_SEPARABLE_COMPILATION ON)
This property is initialized by the value of the CMAKE_CUDA_SEPARABLE_COMPILATION variable if it is set when a target is created.
CUDA only: Enables device linking for the specific static library target
If set this will enable device linking on this static library target. Normally device linking is deferred until a shared library or executable is generated, allowing for multiple static libraries to resolve device symbols at the same time.
For instance:
set_property(TARGET mystaticlib PROPERTY CUDA_RESOLVE_DEVICE_SYMBOLS ON)
Boolean specifying whether compiler specific extensions are requested.
This property specifies whether compiler specific extensions should be used. For some compilers, this results in adding a flag such as -std=gnu++11 instead of -std=c++11 to the compile line. This property is ON by default. The basic CUDA/C++ standard level is controlled by the CUDA_STANDARD target property.
See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
This property is initialized by the value of the CMAKE_CUDA_EXTENSIONS variable if it is set when a target is created.
The CUDA/C++ standard whose features are requested to build this target.
This property specifies the CUDA/C++ standard whose features are requested to build this target. For some compilers, this results in adding a flag such as -std=gnu++11 to the compile line.
Supported values are 98, 11, 14.
If the value requested does not result in a compile flag being added for the compiler in use, a previous standard flag will be added instead. This means that using:
set_property(TARGET tgt PROPERTY CUDA_STANDARD 11)
with a compiler which does not support -std=gnu++11 or an equivalent flag will not result in an error or warning, but will instead add the -std=gnu++98 flag if supported. This “decay” behavior may be controlled with the CUDA_STANDARD_REQUIRED target property. Additionally, the CUDA_EXTENSIONS target property may be used to control whether compiler-specific extensions are enabled on a per-target basis.
See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
This property is initialized by the value of the CMAKE_CUDA_STANDARD variable if it is set when a target is created.
Boolean describing whether the value of CUDA_STANDARD is a requirement.
If this property is set to ON, then the value of the CUDA_STANDARD target property is treated as a requirement. If this property is OFF or unset, the CUDA_STANDARD target property is treated as optional and may “decay” to a previous standard if the requested is not available. For compilers that have no notion of a standard level, such as MSVC, this has no effect.
See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
This property is initialized by the value of the CMAKE_CUDA_STANDARD_REQUIRED variable if it is set when a target is created.
Boolean specifying whether compiler specific extensions are requested.
This property specifies whether compiler specific extensions should be used. For some compilers, this results in adding a flag such as -std=gnu++11 instead of -std=c++11 to the compile line. This property is ON by default. The basic C++ standard level is controlled by the CXX_STANDARD target property.
See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
This property is initialized by the value of the CMAKE_CXX_EXTENSIONS variable if it is set when a target is created.
The C++ standard whose features are requested to build this target.
This property specifies the C++ standard whose features are requested to build this target. For some compilers, this results in adding a flag such as -std=gnu++11 to the compile line. For compilers that have no notion of a standard level, such as Microsoft Visual C++ before 2015 Update 3, this has no effect.
Supported values are 98, 11, 14, 17, and 20.
If the value requested does not result in a compile flag being added for the compiler in use, a previous standard flag will be added instead. This means that using:
set_property(TARGET tgt PROPERTY CXX_STANDARD 11)
with a compiler which does not support -std=gnu++11 or an equivalent flag will not result in an error or warning, but will instead add the -std=gnu++98 flag if supported. This “decay” behavior may be controlled with the CXX_STANDARD_REQUIRED target property. Additionally, the CXX_EXTENSIONS target property may be used to control whether compiler-specific extensions are enabled on a per-target basis.
See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
This property is initialized by the value of the CMAKE_CXX_STANDARD variable if it is set when a target is created.
Boolean describing whether the value of CXX_STANDARD is a requirement.
If this property is set to ON, then the value of the CXX_STANDARD target property is treated as a requirement. If this property is OFF or unset, the CXX_STANDARD target property is treated as optional and may “decay” to a previous standard if the requested is not available. For compilers that have no notion of a standard level, such as MSVC, this has no effect.
See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
This property is initialized by the value of the CMAKE_CXX_STANDARD_REQUIRED variable if it is set when a target is created.
See target property <CONFIG>_POSTFIX.
This property is a special case of the more-general <CONFIG>_POSTFIX property for the DEBUG configuration.
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.
Set the WinCE project RemoteDirectory in DeploymentTool and RemoteExecutable in DebuggerTool in .vcproj files generated by the Visual Studio 9 2008 generator. This is useful when you want to debug on remote WinCE device. For example:
set_property(TARGET ${TARGET} PROPERTY
DEPLOYMENT_REMOTE_DIRECTORY "\\FlashStorage")
produces:
<DeploymentTool RemoteDirectory="\FlashStorage" ... /> <DebuggerTool RemoteExecutable="\FlashStorage\target_file" ... />
Set the WinCE project AdditionalFiles in DeploymentTool in .vcproj files generated by the Visual Studio 9 2008 generator. This is useful when you want to debug on remote WinCE device. Specify additional files that will be copied to the device. For example:
set_property(TARGET ${TARGET} PROPERTY
DEPLOYMENT_ADDITIONAL_FILES "english.lng|local_folder|remote_folder|0"
"german.lng|local_folder|remote_folder|0")
produces:
<DeploymentTool AdditionalFiles="english.lng|local_folder|remote_folder|0;german.lng|local_folder|remote_folder|0" ... />
Specify the .NET target framework version.
Used to specify the .NET target framework version for C++/CLI. For example, “v4.5”.
This property is only evaluated for Visual Studio Generators VS 2010 and above.
Can be initialized for all targets using the variable CMAKE_DOTNET_TARGET_FRAMEWORK_VERSION.
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.
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 macOS, 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.
This property is initialized by the value of the variable CMAKE_ENABLE_EXPORTS if it is set when a target is created.
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.
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.
Exclude target from “Build Solution”.
This property is only used by Visual Studio generators. When set to TRUE, the target will not be built when you press “Build Solution”.
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.
List additional properties to export for a target.
This property contains a list of property names that should be exported by the install(EXPORT) and export() commands. By default only a limited number of properties are exported. This property can be used to additionally export other properties as well.
Properties starting with INTERFACE_ or IMPORTED_ are not allowed as they are reserved for internal CMake use.
Properties containing generator expressions are also not allowed.
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.
This property is initialized by the value of the variable CMAKE_FOLDER if it is set when a target is created.
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.
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.
Build SHARED or STATIC library as Framework Bundle on the macOS and iOS.
If such a library target has this property set to TRUE it will be built as a framework when built on the macOS and iOS. It will have the directory structure required for a framework and will be suitable to be used with the -framework option
To customize Info.plist file in the framework, use MACOSX_FRAMEWORK_INFO_PLIST target property.
For macOS see also the FRAMEWORK_VERSION target property.
Example of creation dynamicFramework:
add_library(dynamicFramework SHARED
dynamicFramework.c
dynamicFramework.h ) set_target_properties(dynamicFramework PROPERTIES
FRAMEWORK TRUE
FRAMEWORK_VERSION C
MACOSX_FRAMEWORK_IDENTIFIER com.cmake.dynamicFramework
MACOSX_FRAMEWORK_INFO_PLIST Info.plist
# "current version" in semantic format in Mach-O binary file
VERSION 16.4.0
# "compatibility version" in semantic format in Mach-O binary file
SOVERSION 1.0.0
PUBLIC_HEADER dynamicFramework.h
XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY "iPhone Developer" )
Version of a framework created using the FRAMEWORK target property (e.g. A).
This property only affects macOS, as iOS doesn’t have versioned directory structure.
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().
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.
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.
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.
Property to define if the target uses C++/CLI.
Ignored for non-imported targets.
See also the COMMON_LANGUAGE_RUNTIME target property.
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.
Indication of whether an IMPORTED target is globally visible.
The boolean value of this property is True for targets created with the IMPORTED GLOBAL options to add_executable() or add_library(). It is always False for targets built within the project.
For targets created with the IMPORTED option to add_executable() or add_library() but without the additional option GLOBAL this is False, too. However, setting this property for such a locally IMPORTED target to True promotes that target to global scope. This promotion can only be done in the same directory where that IMPORTED target was created in the first place.
Once an imported target has been made global, it cannot be changed back to non-global. Therefore, if a project sets this property, it may only provide a value of True. CMake will issue an error if the project tries to set the property to a non-True value, even if the value was already False.
<CONFIG>-specific version of IMPORTED_IMPLIB property.
Configuration names correspond to those provided by the project from which the target is imported.
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.
<CONFIG>-specific version of IMPORTED_LIBNAME property.
Configuration names correspond to those provided by the project from which the target is imported.
Specify the link library name for an imported Interface Library.
An interface library builds no library file itself but does specify usage requirements for its consumers. The IMPORTED_LIBNAME property may be set to specify a single library name to be placed on the link line in place of the interface library target name as a requirement for using the interface.
This property is intended for use in naming libraries provided by a platform SDK for which the full path to a library file may not be known. The value may be a plain library name such as foo but may not be a path (e.g. /usr/lib/libfoo.so) or a flag (e.g. -Wl,...). The name is never treated as a library target name even if it happens to name one.
The IMPORTED_LIBNAME property is allowed only on imported Interface Libraries and is rejected on targets of other types (for which the IMPORTED_LOCATION target property may be used).
<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.
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.
<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.
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.
<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.
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.
<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_MULTIPLICITY.
If set, this property completely overrides the generic property for the named configuration.
Repetition count for cycles of IMPORTED static libraries.
This is LINK_INTERFACE_MULTIPLICITY for IMPORTED targets.
<CONFIG>-specific version of IMPORTED_LOCATION property.
Configuration names correspond to those provided by the project from which the target is imported.
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 macOS 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 macOS 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.
<CONFIG>-specific version of IMPORTED_NO_SONAME property.
Configuration names correspond to those provided by the project from which the target is imported.
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.
<CONFIG>-specific version of IMPORTED_OBJECTS property.
Configuration names correspond to those provided by the project from which the target is imported.
;-list of absolute paths to the object files on disk for an imported object library.
Ignored for non-imported targets.
Projects may skip IMPORTED_OBJECTS if the configuration-specific property IMPORTED_OBJECTS_<CONFIG> is set instead.
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.
<CONFIG>-specific version of IMPORTED_SONAME property.
Configuration names correspond to those provided by the project from which the target is imported.
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.
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.
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.
List of preprocessor include file search directories.
This property specifies the list of directories given so far to the target_include_directories() command. In addition to accepting values from that command, values may be set directly on any target using the set_property() command. A target gets its initial value for this property from the value of the INCLUDE_DIRECTORIES directory property. Both directory and target property values are adjusted by calls to the include_directories() command.
The value of this property is used by the generators to set the include paths for the compiler.
Relative paths should not be added to this property directly. Use one of the commands above instead to handle relative paths.
Contents of INCLUDE_DIRECTORIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
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.
This property is initialized by the value of the variable CMAKE_INSTALL_NAME_DIR if it is set when a target is created.
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.
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.
List of interface options to pass to uic.
Targets may populate this property to publish the options required to use when invoking uic. Consuming targets can add entries to their own AUTOUIC_OPTIONS property such as $<TARGET_PROPERTY:foo,INTERFACE_AUTOUIC_OPTIONS> to use the uic options specified in the interface of foo. This is done automatically by the target_link_libraries() command.
This property supports generator expressions. See the cmake-generator-expressions(7) manual for available expressions.
List of public compile definitions requirements for a library.
Targets may populate this property to publish the compile definitions required to compile against the headers for the target. The target_compile_definitions() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.
When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.
Contents of INTERFACE_COMPILE_DEFINITIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.
List of public compile features requirements for a library.
Targets may populate this property to publish the compile features required to compile against the headers for the target. The target_compile_features() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.
When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.
Contents of INTERFACE_COMPILE_FEATURES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.
See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.
List of public compile options requirements for a library.
Targets may populate this property to publish the compile options required to compile against the headers for the target. The target_compile_options() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.
When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.
Contents of INTERFACE_COMPILE_OPTIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.
List of public include directories requirements for a library.
Targets may populate this property to publish the include directories required to compile against the headers for the target. The target_include_directories() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.
When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.
Contents of INTERFACE_INCLUDE_DIRECTORIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.
Include directories usage requirements commonly differ between the build-tree and the install-tree. The BUILD_INTERFACE and INSTALL_INTERFACE generator expressions can be used to describe separate usage requirements based on the usage location. Relative paths are allowed within the INSTALL_INTERFACE expression and are interpreted relative to the installation prefix. For example:
target_include_directories(mylib INTERFACE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/mylib>
$<INSTALL_INTERFACE:include/mylib> # <prefix>/include/mylib )
Note that it is not advisable to populate the INSTALL_INTERFACE of the INTERFACE_INCLUDE_DIRECTORIES of a target with absolute paths to the include directories of dependencies. That would hard-code into installed packages the include directory paths for dependencies as found on the machine the package was made on.
The INSTALL_INTERFACE of the INTERFACE_INCLUDE_DIRECTORIES is only suitable for specifying the required include directories for headers provided with the target itself, not those provided by the transitive dependencies listed in its INTERFACE_LINK_LIBRARIES target property. Those dependencies should themselves be targets that specify their own header locations in INTERFACE_INCLUDE_DIRECTORIES.
See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.
Additional public interface files on which a target binary depends for linking.
This property is supported only by Makefile and Ninja generators. It is intended to specify dependencies on “linker scripts” for custom Makefile link rules.
When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.
Contents of INTERFACE_LINK_DEPENDS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.
Link dependency files usage requirements commonly differ between the build-tree and the install-tree. The BUILD_INTERFACE and INSTALL_INTERFACE generator expressions can be used to describe separate usage requirements based on the usage location. Relative paths are allowed within the INSTALL_INTERFACE expression and are interpreted relative to the installation prefix. For example:
set_property(TARGET mylib PROPERTY INTERFACE_LINK_DEPENDS
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/mylinkscript>
$<INSTALL_INTERFACE:mylinkscript> # <prefix>/mylinkscript )
List of public link directories requirements for a library.
Targets may populate this property to publish the link directories required to compile against the headers for the target. The target_link_directories() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.
When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.
Contents of INTERFACE_LINK_DIRECTORIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.
List public interface libraries for a library.
This property contains the list of transitive link dependencies. When the target is linked into another target using the target_link_libraries() command, the libraries listed (and recursively their link interface libraries) will be provided to the other target also. This property is overridden by the LINK_INTERFACE_LIBRARIES or LINK_INTERFACE_LIBRARIES_<CONFIG> property if policy CMP0022 is OLD or unset.
Contents of INTERFACE_LINK_LIBRARIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
NOTE:
Note that it is not advisable to populate the INTERFACE_LINK_LIBRARIES of a target with absolute paths to dependencies. That would hard-code into installed packages the library file paths for dependencies as found on the machine the package was made on.
See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.
List of public link options requirements for a library.
Targets may populate this property to publish the link options required to compile against the headers for the target. The target_link_options() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.
When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.
Contents of INTERFACE_LINK_OPTIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.
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.
List of interface sources to compile into consuming targets.
Targets may populate this property to publish the sources for consuming targets to compile. The target_sources() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.
When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the sources of the consumer.
Contents of INTERFACE_SOURCES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
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. The target_include_directories(SYSTEM) command signature populates this property with values given to the PUBLIC and INTERFACE keywords.
Projects may also get and set the property directly, but must be aware that adding directories to this property does not make those directories used during compilation. Adding directories to this property marks directories as SYSTEM which otherwise would be used in a non-SYSTEM manner. This can appear similar to ‘duplication’, so prefer the high-level target_include_directories(SYSTEM) command and avoid setting the property by low-level means.
When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to mark the same include directories as containing system headers.
Contents of INTERFACE_SYSTEM_INCLUDE_DIRECTORIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
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.
This property is initialized by the CMAKE_INTERPROCEDURAL_OPTIMIZATION_<CONFIG> variable if it is set when a target is created.
Enable interprocedural optimization for a target.
If set to true, enables interprocedural optimizations if they are known to be supported by the compiler.
This property is initialized by the CMAKE_INTERPROCEDURAL_OPTIMIZATION variable if it is set when a target is created.
Build a combined (device and simulator) target when installing.
When this property is set to set to false (which is the default) then it will either be built with the device SDK or the simulator SDK depending on the SDK set. But if this property is set to true then the target will at install time also be built for the corresponding SDK and combined into one library.
This feature requires at least Xcode version 6.
Ninja only: Pool used for compiling.
The number of parallel compile processes could be limited by defining pools with the global JOB_POOLS property and then specifying here the pool name.
For instance:
set_property(TARGET myexe PROPERTY JOB_POOL_COMPILE ten_jobs)
This property is initialized by the value of CMAKE_JOB_POOL_COMPILE.
Ninja only: Pool used for linking.
The number of parallel link processes could be limited by defining pools with the global JOB_POOLS property and then specifying here the pool name.
For instance:
set_property(TARGET myexe PROPERTY JOB_POOL_LINK two_jobs)
This property is initialized by the value of CMAKE_JOB_POOL_LINK.
Specify a list of text labels associated with a target.
Target label semantics are currently unspecified.
This property is implemented only when <LANG> is C or CXX.
Specify a ;-list containing a command line for the clang-tidy tool. The Makefile Generators and the Ninja generator will run this tool along with the compiler and report a warning if the tool reports any problems.
This property is initialized by the value of the CMAKE_<LANG>_CLANG_TIDY variable if it is set when a target is created.
This property is implemented only when <LANG> is C, CXX, Fortran, or CUDA.
Specify a ;-list containing a command line for a compiler launching tool. The Makefile Generators and the Ninja generator will run this tool and pass the compiler and its arguments to the tool. Some example tools are distcc and ccache.
This property is initialized by the value of the CMAKE_<LANG>_COMPILER_LAUNCHER variable if it is set when a target is created.
This property is supported only when <LANG> is C or CXX.
Specify a ;-list containing a command line for the cppcheck static analysis tool. The Makefile Generators and the Ninja generator will run cppcheck along with the compiler and report any problems.
This property is initialized by the value of the CMAKE_<LANG>_CPPCHECK variable if it is set when a target is created.
This property is supported only when <LANG> is C or CXX.
Specify a ;-list containing a command line for the cpplint style checker. The Makefile Generators and the Ninja generator will run cpplint along with the compiler and report any problems.
This property is initialized by the value of the CMAKE_<LANG>_CPPLINT variable if it is set when a target is created.
This property is implemented only when <LANG> is C or CXX.
Specify a ;-list containing a command line for the include-what-you-use tool. The Makefile Generators and the Ninja generator will run this tool along with the compiler and report a warning if the tool reports any problems.
This property is initialized by the value of the CMAKE_<LANG>_INCLUDE_WHAT_YOU_USE variable if it is set when a target is created.
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 affects compilation in sources of all types of targets (subject to policy CMP0063).
This property is initialized by the value of the CMAKE_<LANG>_VISIBILITY_PRESET variable if it is set when a target is created.
Per-configuration output directory for LIBRARY target files.
This is a per-configuration version of the LIBRARY_OUTPUT_DIRECTORY target property, 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 CMAKE_LIBRARY_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.
Contents of LIBRARY_OUTPUT_DIRECTORY_<CONFIG> may use generator expressions.
Output directory in which to build LIBRARY target files.
This property specifies the directory into which library target files should be built. The property value may use generator expressions. Multi-configuration generators (VS, Xcode) append a per-configuration subdirectory to the specified directory unless a generator expression is used.
This property is initialized by the value of the variable CMAKE_LIBRARY_OUTPUT_DIRECTORY if it is set when a target is created.
See also the LIBRARY_OUTPUT_DIRECTORY_<CONFIG> target property.
Per-configuration output name for LIBRARY target files.
This is the configuration-specific version of the LIBRARY_OUTPUT_NAME target property.
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.
See also the LIBRARY_OUTPUT_NAME_<CONFIG> target property.
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.
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 supported only by Makefile and Ninja generators. It is intended to specify dependencies on “linker scripts” for custom Makefile link rules.
Contents of LINK_DEPENDS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
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.
List of directories to use for the link step of shared library, module and executable targets.
This property holds a ;-list of directories specified so far for its target. Use the target_link_directories() command to append more search directories.
This property is initialized by the LINK_DIRECTORIES directory property when a target is created, and is used by the generators to set the search directories for the linker.
Contents of LINK_DIRECTORIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
Per-configuration linker flags for a shared library, module or executable target.
This is the configuration-specific version of LINK_FLAGS.
NOTE:
Additional flags to use when linking this target if it is a shared library, module library, or an executable. Static libraries need to use STATIC_LIBRARY_OPTIONS or STATIC_LIBRARY_FLAGS properties.
The LINK_FLAGS property, managed as a string, 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, …
NOTE:
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 overridden by the INTERFACE_LINK_LIBRARIES property if policy CMP0022 is NEW.
This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead.
Note that it is not advisable to populate the LINK_INTERFACE_LIBRARIES_<CONFIG> of a target with absolute paths to dependencies. That would hard-code into installed packages the library file paths for dependencies as found on the machine the package was made on.
See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.
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 target 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 using the target_link_libraries() command, 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 CMAKE_LINK_INTERFACE_LIBRARIES variable if it is set when a target is created. This property is ignored for STATIC libraries.
This property is overridden by the INTERFACE_LINK_LIBRARIES property if policy CMP0022 is NEW.
This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead.
Note that it is not advisable to populate the LINK_INTERFACE_LIBRARIES of a target with absolute paths to dependencies. That would hard-code into installed packages the library file paths for dependencies as found on the machine the package was made on.
See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.
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.
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.
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 value of this property is used by the generators to set the link libraries for the compiler.
Contents of LINK_LIBRARIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
NOTE:
List of options to use for the link step of shared library, module and executable targets. Targets that are static libraries need to use the STATIC_LIBRARY_OPTIONS target property.
This property holds a ;-list of options specified so far for its target. Use the target_link_options() command to append more options.
This property is initialized by the LINK_OPTIONS directory property when a target is created, and is used by the generators to set the options for the compiler.
Contents of LINK_OPTIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
NOTE:
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.
This property is initialized by the value of the variable CMAKE_LINK_SEARCH_END_STATIC if it is set when a target is created.
See also 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).
This property is initialized by the value of the variable CMAKE_LINK_SEARCH_START_STATIC if it is set when a target is created.
See also LINK_SEARCH_END_STATIC.
This is a boolean option that when set to TRUE will automatically run ldd -r -u on the target after it is linked. In addition, the linker flag -Wl,--no-as-needed will be passed to the target with the link command so that all libraries specified on the command line will be linked into the target. This will result in the link producing a list of libraries that provide no symbols used by this target but are being linked to it. This is only applicable to executable and shared library targets and will only work when ld and ldd accept the flags used.
This property is initialized by the value of the CMAKE_LINK_WHAT_YOU_USE variable if it is set when a target is created.
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.
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.
Specify a custom Info.plist template for a macOS and iOS Application Bundle.
An executable target with MACOSX_BUNDLE enabled will be built as an application bundle on macOS. 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:
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.
Build an executable as an Application Bundle on macOS or iOS.
When this property is set to TRUE the executable when built on macOS or iOS 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.
Specify a custom Info.plist template for a macOS and iOS Framework.
A library target with FRAMEWORK enabled will be built as a framework on macOS. 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:
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.
Whether this target on macOS or iOS is located at runtime using rpaths.
When this property is set to TRUE, the directory portion of the install_name field of this shared library will be @rpath unless overridden by INSTALL_NAME_DIR. This indicates the shared library is to be found at runtime using runtime paths (rpaths).
This property is initialized by the value of the variable CMAKE_MACOSX_RPATH if it is set when a target is created.
Runtime paths will also be embedded in binaries using this target and can be controlled by the INSTALL_RPATH target property on the target linking to this target.
Policy CMP0042 was introduced to change the default value of MACOSX_RPATH to TRUE. This is because use of @rpath is a more flexible and powerful alternative to @executable_path and @loader_path.
Get manually added dependencies to other top-level targets.
This read-only property can be used to query all dependencies that were added for this target with the add_dependencies() command.
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 (i.e. via IMPORTED_LOCATION_<CONFIG> for the mapped-to <CONFIG>) is selected. As a special case, an empty list element refers to the configuration-less imported target location (i.e. IMPORTED_LOCATION).
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 CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> variable if it is set when a target is created.
For example creating imported C++ library foo:
add_library(foo STATIC IMPORTED)
Use foo_debug path for Debug build type:
set_property(
TARGET foo APPEND PROPERTY IMPORTED_CONFIGURATIONS DEBUG
) set_target_properties(foo PROPERTIES
IMPORTED_LINK_INTERFACE_LANGUAGES_DEBUG "CXX"
IMPORTED_LOCATION_DEBUG "${foo_debug}"
)
Use foo_release path for Release build type:
set_property(
TARGET foo APPEND PROPERTY IMPORTED_CONFIGURATIONS RELEASE
) set_target_properties(foo PROPERTIES
IMPORTED_LINK_INTERFACE_LANGUAGES_RELEASE "CXX"
IMPORTED_LOCATION_RELEASE "${foo_release}"
)
Use Release version of library for MinSizeRel and RelWithDebInfo build types:
set_target_properties(foo PROPERTIES
MAP_IMPORTED_CONFIG_MINSIZEREL Release
MAP_IMPORTED_CONFIG_RELWITHDEBINFO Release
)
Logical name for the target.
Read-only logical name for the target as used by CMake.
Whether to set “soname” when linking a shared library.
Enable this boolean property if a generated shared library should not have “soname” set. Default is to set “soname” on all shared libraries 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.
Do not treat include directories from the interfaces of consumed imported targets as SYSTEM.
The contents of the INTERFACE_INCLUDE_DIRECTORIES target property of imported targets are treated as SYSTEM includes by default. If this property is enabled on a target, compilation of sources in that target will not treat the contents of the INTERFACE_INCLUDE_DIRECTORIES of consumed imported targets as system includes.
This property is initialized by the value of the CMAKE_NO_SYSTEM_FROM_IMPORTED variable if it is set when a target is created.
Per-configuration macOS and iOS binary architectures for a target.
This property is the configuration-specific version of OSX_ARCHITECTURES.
Target specific architectures for macOS.
The OSX_ARCHITECTURES property sets the target binary architecture for targets on macOS (-arch). 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, where <CONFIG> is an upper-case name (e.g. OSX_ARCHITECTURES_DEBUG).
Per-configuration target file base name.
This is the configuration-specific version of the OUTPUT_NAME target property.
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 during generation. The value is not set by default during configuration.
Contents of OUTPUT_NAME and the variants listed below may use generator expressions.
See also the variants:
Per-configuration output name for the MS debug symbol .pdb file generated by the linker for an executable or shared library target.
This is the configuration-specific version of PDB_NAME.
NOTE:
The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the COMPILE_PDB_NAME_<CONFIG> property to specify the latter.
Output name for the MS debug symbol .pdb file generated by the linker for an executable or shared library target.
This property specifies the base name for the debug symbols file. If not set, the OUTPUT_NAME target property value or logical target name is used by default.
NOTE:
The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the COMPILE_PDB_NAME property to specify the latter.
Per-configuration output directory for the MS debug symbol .pdb file generated by the linker for an executable or shared library target.
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 CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.
Contents of PDB_OUTPUT_DIRECTORY_<CONFIG> may use generator expressions.
NOTE:
The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG> property to specify the latter.
Output directory for the MS debug symbols .pdb file generated by the linker for an executable or shared library target.
This property specifies the directory into which the MS debug symbols will be placed by the linker. The property value may use generator expressions. Multi-configuration generators append a per-configuration subdirectory to the specified directory unless a generator expression is used.
This property is initialized by the value of the CMAKE_PDB_OUTPUT_DIRECTORY variable if it is set when a target is created.
NOTE:
The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the COMPILE_PDB_OUTPUT_DIRECTORY property to specify the latter.
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 CMAKE_POSITION_INDEPENDENT_CODE variable if it is set when a target is created.
What comes before the library name.
A target property that can be set to override the prefix (such as “lib”) on a library name.
Specify private header files in a FRAMEWORK shared library target.
Shared library targets marked with the FRAMEWORK property generate frameworks on macOS, iOS 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.
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.
Specify public header files in a FRAMEWORK shared library target.
Shared library targets marked with the FRAMEWORK property generate frameworks on macOS, iOS 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.
Specify resource files in a FRAMEWORK or BUNDLE.
Target marked with the FRAMEWORK or BUNDLE property generate framework or application bundle (both macOS and iOS is supported) or normal shared libraries on other platforms. This property may be set to a list of files to be placed in the corresponding directory (eg. Resources directory for macOS) inside the bundle. On non-Apple platforms these files may be installed using the RESOURCE option to the install(TARGETS) command.
Following example of Application Bundle:
add_executable(ExecutableTarget
addDemo.c
resourcefile.txt
appresourcedir/appres.txt ) target_link_libraries(ExecutableTarget heymath mul) set(RESOURCE_FILES
resourcefile.txt
appresourcedir/appres.txt ) set_target_properties(ExecutableTarget PROPERTIES
MACOSX_BUNDLE TRUE
MACOSX_FRAMEWORK_IDENTIFIER org.cmake.ExecutableTarget
RESOURCE "${RESOURCE_FILES}" )
will produce flat structure for iOS systems:
ExecutableTarget.app
appres.txt
ExecutableTarget
Info.plist
resourcefile.txt
For macOS systems it will produce following directory structure:
ExecutableTarget.app/
Contents
Info.plist
MacOS
ExecutableTarget
Resources
appres.txt
resourcefile.txt
For Linux, such cmake script produce following files:
ExecutableTarget Resources
appres.txt
resourcefile.txt
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.
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.
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.
Per-configuration output directory for RUNTIME target files.
This is a per-configuration version of the RUNTIME_OUTPUT_DIRECTORY target property, 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 CMAKE_RUNTIME_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.
Contents of RUNTIME_OUTPUT_DIRECTORY_<CONFIG> may use generator expressions.
Output directory in which to build RUNTIME target files.
This property specifies the directory into which runtime target files should be built. The property value may use generator expressions. Multi-configuration generators (VS, Xcode) append a per-configuration subdirectory to the specified directory unless a generator expression is used.
This property is initialized by the value of the variable CMAKE_RUNTIME_OUTPUT_DIRECTORY if it is set when a target is created.
See also the RUNTIME_OUTPUT_DIRECTORY_<CONFIG> target property.
Per-configuration output name for RUNTIME target files.
This is the configuration-specific version of the RUNTIME_OUTPUT_NAME target property.
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.
See also the RUNTIME_OUTPUT_NAME_<CONFIG> target property.
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.
This read-only property reports the value of the CMAKE_CURRENT_SOURCE_DIR variable in the directory in which the target was defined.
Source names specified for a target.
List of sources specified for a target.
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.
For shared libraries and executables on Mach-O systems (e.g. macOS, iOS), the SOVERSION property corresponds to compatibility version and VERSION to current version. See the FRAMEWORK target property for an example. Versions of Mach-O binaries may be checked with the otool -L <binary> command.
Per-configuration archiver (or MSVC librarian) flags for a static library target.
This is the configuration-specific version of STATIC_LIBRARY_FLAGS.
NOTE:
Archiver (or MSVC librarian) flags for a static library target. Targets that are shared libraries, modules, or executables need to use the LINK_OPTIONS or LINK_FLAGS target properties.
The STATIC_LIBRARY_FLAGS property, managed as a string, can be used to add extra flags to the link step of a static library target. STATIC_LIBRARY_FLAGS_<CONFIG> will add to the configuration <CONFIG>, for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO, …
NOTE:
Archiver (or MSVC librarian) flags for a static library target. Targets that are shared libraries, modules, or executables need to use the LINK_OPTIONS target property.
This property holds a ;-list of options specified so far for its target. Use set_target_properties() or set_property() commands to set its content.
Contents of STATIC_LIBRARY_OPTIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
NOTE:
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.
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, OBJECT_LIBRARY, INTERFACE_LIBRARY, EXECUTABLE or one of the internal target types.
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.
For shared libraries and executables on Mach-O systems (e.g. macOS, iOS), the SOVERSION property correspond to compatibility version and VERSION to current version. See the FRAMEWORK target property for an example. Versions of Mach-O binaries may be checked with the otool -L <binary> command.
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, such as -fvisibility-inlines-hidden, should be used when invoking the compiler. This property affects compilation in sources of all types of targets (subject to policy CMP0063).
This property is initialized by the value of the CMAKE_VISIBILITY_INLINES_HIDDEN variable if it is set when a target is created.
Visual Studio project configuration type.
Sets the ConfigurationType attribute for a generated Visual Studio project. If this property is set, it overrides the default setting that is based on the target type (e.g. StaticLibrary, Application, …).
Supported on Visual Studio Generators for VS 2010 and higher.
Sets the local debugger command for Visual Studio C++ targets. The property value may use generator expressions. This is defined in <LocalDebuggerCommand> in the Visual Studio project file.
This property only works for Visual Studio 2010 and above; it is ignored on other generators.
Sets the local debugger command line arguments for Visual Studio C++ targets. The property value may use generator expressions. This is defined in <LocalDebuggerCommandArguments> in the Visual Studio project file.
This property only works for Visual Studio 2010 and above; it is ignored on other generators.
Sets the local debugger environment for Visual Studio C++ targets. The property value may use generator expressions. This is defined in <LocalDebuggerEnvironment> in the Visual Studio project file.
This property only works for Visual Studio 2010 and above; it is ignored on other generators.
Sets the local debugger working directory for Visual Studio C++ targets. The property value may use generator expressions. This is defined in <LocalDebuggerWorkingDirectory> in the Visual Studio project file.
This property only works for Visual Studio 2010 and above; it is ignored on other generators.
Visual Studio Windows 10 Desktop Extensions Version
Specifies the version of the Desktop Extensions that should be included in the target. For example 10.0.10240.0. If the value is not specified, the Desktop Extensions will not be included. To use the same version of the extensions as the Windows 10 SDK that is being used, you can use the CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION variable.
Visual Studio managed project .NET reference with name <refname> and hint path.
Adds one .NET reference to generated Visual Studio project. The reference will have the name <refname> and will point to the assembly given as value of the property.
See also VS_DOTNET_REFERENCES and VS_DOTNET_REFERENCES_COPY_LOCAL
Defines an XML property <tagname> for a .NET reference <refname>.
Reference properties can be set for .NET references which are defined by the target properties VS_DOTNET_REFERENCES, VS_DOTNET_REFERENCE_<refname> and also for project references to other C# targets which are established by target_link_libraries().
This property is only applicable to C# targets and Visual Studio generators 2010 and later.
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”.
Sets the Copy Local property for all .NET hint references in the target
Boolean property to enable/disable copying of .NET hint references to output directory. The default is ON.
Specify the .NET target framework version.
Used to specify the .NET target framework version for C++/CLI. For example, “v4.5”.
This property is deprecated and should not be used anymore. Use DOTNET_TARGET_FRAMEWORK_VERSION instead.
Visual Studio project keyword for VS 10 (2010) and newer.
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.
Use the VS_KEYWORD target property to set the keyword for Visual Studio 9 (2008) and older.
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.
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.
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”
Visual Studio Windows 10 IoT Extensions Version
Specifies the version of the IoT Extensions that should be included in the target. For example 10.0.10240.0. If the value is not specified, the IoT Extensions will not be included. To use the same version of the extensions as the Windows 10 SDK that is being used, you can use the CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION variable.
Visual Studio Windows 10 IoT Continuous Background Task
Specifies that the target should be compiled as a Continuous Background Task library.
Visual Studio project keyword for VS 9 (2008) and older.
Can be set to change the visual studio keyword, for example Qt integration works better if this is set to Qt4VSv1.0.
Use the VS_GLOBAL_KEYWORD target property to set the keyword for Visual Studio 10 (2010) and newer.
Visual Studio Windows 10 Mobile Extensions Version
Specifies the version of the Mobile Extensions that should be included in the target. For example 10.0.10240.0. If the value is not specified, the Mobile Extensions will not be included. To use the same version of the extensions as the Windows 10 SDK that is being used, you can use the CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION variable.
Visual Studio Source Code Control Aux Path.
Can be set to change the visual studio source code control auxpath property.
Visual Studio Source Code Control Local Path.
Can be set to change the visual studio source code control local path property.
Visual Studio Source Code Control Project.
Can be set to change the visual studio source code control project name property.
Visual Studio Source Code Control Provider.
Can be set to change the visual studio source code control provider property.
Visual Studio project SDK references. Specify a ;-list of SDK references to be added to a generated Visual Studio project, e.g. Microsoft.AdMediatorWindows81, Version=1.0.
Sets the user props file to be included in the visual studio C++ project file. The standard path is $(UserRootDir)\\Microsoft.Cpp.$(Platform).user.props, which is in most cases the same as %LOCALAPPDATA%\\Microsoft\\MSBuild\\v4.0\\Microsoft.Cpp.Win32.user.props or %LOCALAPPDATA%\\Microsoft\\MSBuild\\v4.0\\Microsoft.Cpp.x64.user.props.
The *.user.props files can be used for Visual Studio wide configuration which is independent from cmake.
Visual Studio Windows Target Platform Minimum Version
For Windows 10. Specifies the minimum version of the OS that is being targeted. For example 10.0.10240.0. If the value is not specified, the value of CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION will be used on WindowsStore projects otherwise the target platform minimum version will not be specified for the project.
Mark a target as a Windows Runtime component for the Visual Studio generator. Compile the target with C++/CX language extensions for Windows Runtime. For SHARED and MODULE libraries, this also defines the _WINRT_DLL preprocessor macro.
NOTE:
Deprecated. Use VS_WINRT_COMPONENT instead. This property was an experimental partial implementation of that one.
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”.
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.
This property is implemented only for MS-compatible tools on Windows.
Enable this boolean property to automatically create a module definition (.def) file with all global symbols found in the input .obj files for a SHARED library (or executable with ENABLE_EXPORTS) on Windows. The module definition file will be passed to the linker causing all symbols to be exported from the .dll. For global data symbols, __declspec(dllimport) must still be used when compiling against the code in the .dll. All other function symbols will be automatically exported and imported by callers. This simplifies porting projects to Windows by reducing the need for explicit dllexport markup, even in C++ classes.
When this property is enabled, zero or more .def files may also be specified as source files of the target. The exports named by these files will be merged with those detected from the object files to generate a single module definition file to be passed to the linker. This can be used to export symbols from a .dll that are not in any of its object files but are added by the linker from dependencies (e.g. msvcrt.lib).
This property is initialized by the value of the CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS variable if it is set when a target is created.
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.
See the CMAKE_XCODE_ATTRIBUTE_<an-attribute> variable to set attributes on all targets in a directory tree.
Contents of XCODE_ATTRIBUTE_<an-attribute> may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
Set the Xcode explicitFileType attribute on its reference to a target. CMake computes a default based on target type but can be told explicitly with this property.
See also XCODE_PRODUCT_TYPE.
Set the Xcode productType attribute on its reference to a target. CMake computes a default based on target type but can be told explicitly with this property.
See also XCODE_EXPLICIT_FILE_TYPE.
Whether to enable Address Sanitizer in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Detect use of stack after return in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Thread Sanitizer in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_THREAD_SANITIZER if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Thread Sanitizer - Pause on issues in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_THREAD_SANITIZER_STOP if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Undefined Behavior Sanitizer in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Undefined Behavior Sanitizer option Pause on issues in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to disable the Main Thread Checker in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable the Main Thread Checker option Pause on issues in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Malloc Scribble in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_MALLOC_SCRIBBLE if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Malloc Guard Edges in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_MALLOC_GUARD_EDGES if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Guard Malloc in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_GUARD_MALLOC if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Zombie Objects in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_ZOMBIE_OBJECTS if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Malloc Stack in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_MALLOC_STACK if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Dynamic Linker API usage in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Whether to enable Dynamic Library Loads in the Diagnostics section of the generated Xcode scheme.
This property is initialized by the value of the variable CMAKE_XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS if it is set when a target is created.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Specify path to executable in the Info section of the generated Xcode scheme. If not set the schema generator will select the current target if it is actually executable.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Specify command line arguments that should be added to the Arguments section of the generated Xcode scheme.
If set to a list of arguments those will be added to the scheme.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
Specify environment variables that should be added to the Arguments section of the generated Xcode scheme.
If set to a list of environment variables and values of the form MYVAR=value those environment variables will be added to the scheme.
Please refer to the CMAKE_XCODE_GENERATE_SCHEME variable documentation to see all Xcode schema related properties.
This target is a XCTest CFBundle on the Mac.
This property will usually get set via the xctest_add_bundle() macro in FindXCTest module.
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.
This property depends on BUNDLE to be effective.
Attach a list of files to a dashboard submission if the test fails.
Same as ATTACHED_FILES, but these files will only be included if the test does not pass.
Attach a list of files to a dashboard submission.
Set this property to a list of files that will be encoded and submitted to the dashboard as an addition to the test result.
Set this to a floating point value. Tests in a test set will be run in descending order of cost.
This property describes the cost of a test. You can explicitly set this value; tests with higher COST values will run first.
Specifies that this test should only be run after the specified list of tests.
Set this to a list of tests that must finish before this test is run. The results of those tests are not considered, the dependency relationship is purely for order of execution (i.e. it is really just a run after relationship). Consider using test fixtures with setup tests if a dependency with successful completion is required (see FIXTURES_REQUIRED).
If set to true, the test will be skipped and its status will be ‘Not Run’. A DISABLED test will not be counted in the total number of tests and its completion status will be reported to CDash as ‘Disabled’.
A DISABLED test does not participate in test fixture dependency resolution. If a DISABLED test has fixture requirements defined in its FIXTURES_REQUIRED property, it will not cause setup or cleanup tests for those fixtures to be added to the test set.
If a test with the FIXTURES_SETUP property set is DISABLED, the fixture behavior will be as though that setup test was passing and any test case requiring that fixture will still run.
Specify environment variables that should be defined for running a test.
If set to a list of environment variables and values of the form MYVAR=value those environment variables will be defined while running the test. The environment is restored to its previous state after the test is done.
If the output matches this regular expression the test will fail.
If set, if the output matches one of specified regular expressions, the test will fail. Example:
set_tests_properties(mytest PROPERTIES
FAIL_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed" )
FAIL_REGULAR_EXPRESSION expects a list of regular expressions.
Specifies a list of fixtures for which the test is to be treated as a cleanup test. These fixture names are distinct from test case names and are not required to have any similarity to the names of tests associated with them.
Fixture cleanup tests are ordinary tests with all of the usual test functionality. Setting the FIXTURES_CLEANUP property for a test has two primary effects:
A cleanup test can have multiple fixtures listed in its FIXTURES_CLEANUP property. It will execute only once for the whole CTest run, not once for each fixture. A fixture can also have more than one cleanup test defined. If there are multiple cleanup tests for a fixture, projects can control their order with the usual DEPENDS test property if necessary.
A cleanup test is allowed to require other fixtures, but not any fixture listed in its FIXTURES_CLEANUP property. For example:
# Ok: Dependent fixture is different to cleanup set_tests_properties(cleanupFoo PROPERTIES
FIXTURES_CLEANUP Foo
FIXTURES_REQUIRED Bar ) # Error: cannot require same fixture as cleanup set_tests_properties(cleanupFoo PROPERTIES
FIXTURES_CLEANUP Foo
FIXTURES_REQUIRED Foo )
Cleanup tests will execute even if setup or regular tests for that fixture fail or are skipped.
See FIXTURES_REQUIRED for a more complete discussion of how to use test fixtures.
Specifies a list of fixtures the test requires. Fixture names are case sensitive and they are not required to have any similarity to test names.
Fixtures are a way to attach setup and cleanup tasks to a set of tests. If a test requires a given fixture, then all tests marked as setup tasks for that fixture will be executed first (once for the whole set of tests, not once per test requiring the fixture). After all tests requiring a particular fixture have completed, CTest will ensure all tests marked as cleanup tasks for that fixture are then executed. Tests are marked as setup tasks with the FIXTURES_SETUP property and as cleanup tasks with the FIXTURES_CLEANUP property. If any of a fixture’s setup tests fail, all tests listing that fixture in their FIXTURES_REQUIRED property will not be executed. The cleanup tests for the fixture will always be executed, even if some setup tests fail.
When CTest is asked to execute only a subset of tests (e.g. by the use of regular expressions or when run with the --rerun-failed command line option), it will automatically add any setup or cleanup tests for fixtures required by any of the tests that are in the execution set. This behavior can be overridden with the -FS, -FC and -FA command line options to ctest(1) if desired.
Since setup and cleanup tasks are also tests, they can have an ordering specified by the DEPENDS test property just like any other tests. This can be exploited to implement setup or cleanup using multiple tests for a single fixture to modularise setup or cleanup logic.
The concept of a fixture is different to that of a resource specified by RESOURCE_LOCK, but they may be used together. A fixture defines a set of tests which share setup and cleanup requirements, whereas a resource lock has the effect of ensuring a particular set of tests do not run in parallel. Some situations may need both, such as setting up a database, serialising test access to that database and deleting the database again at the end. For such cases, tests would populate both FIXTURES_REQUIRED and RESOURCE_LOCK to combine the two behaviours. Names used for RESOURCE_LOCK have no relationship with names of fixtures, so note that a resource lock does not imply a fixture and vice versa.
Consider the following example which represents a database test scenario similar to that mentioned above:
add_test(NAME testsDone COMMAND emailResults) add_test(NAME fooOnly COMMAND testFoo) add_test(NAME dbOnly COMMAND testDb) add_test(NAME dbWithFoo COMMAND testDbWithFoo) add_test(NAME createDB COMMAND initDB) add_test(NAME setupUsers COMMAND userCreation) add_test(NAME cleanupDB COMMAND deleteDB) add_test(NAME cleanupFoo COMMAND removeFoos) set_tests_properties(setupUsers PROPERTIES DEPENDS createDB) set_tests_properties(createDB PROPERTIES FIXTURES_SETUP DB) set_tests_properties(setupUsers PROPERTIES FIXTURES_SETUP DB) set_tests_properties(cleanupDB PROPERTIES FIXTURES_CLEANUP DB) set_tests_properties(cleanupFoo PROPERTIES FIXTURES_CLEANUP Foo) set_tests_properties(testsDone PROPERTIES FIXTURES_CLEANUP "DB;Foo") set_tests_properties(fooOnly PROPERTIES FIXTURES_REQUIRED Foo) set_tests_properties(dbOnly PROPERTIES FIXTURES_REQUIRED DB) set_tests_properties(dbWithFoo PROPERTIES FIXTURES_REQUIRED "DB;Foo") set_tests_properties(dbOnly dbWithFoo createDB setupUsers cleanupDB
PROPERTIES RESOURCE_LOCK DbAccess)
Key points from this example:
Specifies a list of fixtures for which the test is to be treated as a setup test. These fixture names are distinct from test case names and are not required to have any similarity to the names of tests associated with them.
Fixture setup tests are ordinary tests with all of the usual test functionality. Setting the FIXTURES_SETUP property for a test has two primary effects:
A setup test can have multiple fixtures listed in its FIXTURES_SETUP property. It will execute only once for the whole CTest run, not once for each fixture. A fixture can also have more than one setup test defined. If there are multiple setup tests for a fixture, projects can control their order with the usual DEPENDS test property if necessary.
A setup test is allowed to require other fixtures, but not any fixture listed in its FIXTURES_SETUP property. For example:
# Ok: dependent fixture is different to setup set_tests_properties(setupFoo PROPERTIES
FIXTURES_SETUP Foo
FIXTURES_REQUIRED Bar ) # Error: cannot require same fixture as setup set_tests_properties(setupFoo PROPERTIES
FIXTURES_SETUP Foo
FIXTURES_REQUIRED Foo )
If any of a fixture’s setup tests fail, none of the tests listing that fixture in its FIXTURES_REQUIRED property will be run. Cleanup tests will, however, still be executed.
See FIXTURES_REQUIRED for a more complete discussion of how to use test fixtures.
Specify a list of text labels associated with a test.
The list is reported in dashboard submissions.
Specify a CDASH measurement and value to be reported for a test.
If set to a name then that name will be reported to CDASH as a named measurement with a value of 1. You may also specify a value by setting MEASUREMENT to “measurement=value”.
The output must match this regular expression for the test to pass.
If set, the test output will be checked against the specified regular expressions and at least one of the regular expressions has to match, otherwise the test will fail. Example:
set_tests_properties(mytest PROPERTIES
PASS_REGULAR_EXPRESSION "TestPassed;All ok" )
PASS_REGULAR_EXPRESSION expects a list of regular expressions.
Set to a true value to ask CTest to launch the test process with CPU affinity for a fixed set of processors. If enabled and supported for the current platform, CTest will choose a set of processors to place in the CPU affinity mask when launching the test process. The number of processors in the set is determined by the PROCESSORS test property or the number of processors available to CTest, whichever is smaller. The set of processors chosen will be disjoint from the processors assigned to other concurrently running tests that also have the PROCESSOR_AFFINITY property enabled.
Set to specify how many process slots this test requires. If not set, the default is 1 processor.
Denotes the number of processors that this test will require. This is typically used for MPI tests, and should be used in conjunction with the ctest_test() PARALLEL_LEVEL option.
This will also be used to display a weighted test timing result in label and subproject summaries in the command line output of ctest(1). The wall clock time for the test run will be multiplied by this property to give a better idea of how much cpu resource CTest allocated for the test.
See also the PROCESSOR_AFFINITY test property.
List of files required to run the test.
If set to a list of files, the test will not be run unless all of the files exist.
Specify a list of resources that are locked by this test.
If multiple tests specify the same resource lock, they are guaranteed not to run concurrently.
See also FIXTURES_REQUIRED if the resource requires any setup or cleanup steps.
Do not run this test in parallel with any other test.
Use this option in conjunction with the ctest_test PARALLEL_LEVEL option to specify that this test should not be run in parallel with any other tests.
Return code to mark a test as skipped.
Sometimes only a test itself can determine if all requirements for the test are met. If such a situation should not be considered a hard failure a return code of the process can be specified that will mark the test as “Not Run” if it is encountered.
How many seconds to allow for this test.
This property if set will limit a test to not take more than the specified number of seconds to run. If it exceeds that the test process will be killed and ctest will move to the next test. This setting takes precedence over CTEST_TEST_TIMEOUT.
Change a test’s timeout duration after a matching line is encountered in its output.
add_test(mytest ...)
set_property(TEST mytest PROPERTY TIMEOUT_AFTER_MATCH "${seconds}" "${regex}")
Allow a test seconds to complete after regex is encountered in its output.
When the test outputs a line that matches regex its start time is reset to the current time and its timeout duration is changed to seconds. Prior to this, the timeout duration is determined by the TIMEOUT property or the CTEST_TEST_TIMEOUT variable if either of these are set. Because the test’s start time is reset, its execution time will not include any time that was spent waiting for the matching output.
TIMEOUT_AFTER_MATCH is useful for avoiding spurious timeouts when your test must wait for some system resource to become available before it can execute. Set TIMEOUT to a longer duration that accounts for resource acquisition and use TIMEOUT_AFTER_MATCH to control how long the actual test is allowed to run.
If the required resource can be controlled by CTest you should use RESOURCE_LOCK instead of TIMEOUT_AFTER_MATCH. This property should be used when only the test itself can determine when its required resources are available.
If set to true, this will invert the pass/fail flag of the test.
This property can be used for tests that are expected to fail and return a non zero return code.
The directory from which the test executable will be called.
If this is not set, the test will be run with the working directory set to the binary directory associated with where the test was created (i.e. the CMAKE_CURRENT_BINARY_DIR for where add_test() was called).
Is this source file an abstract class.
A property on a source file that indicates if the source file represents a class that is abstract. This only makes sense for languages that have a notion of an abstract class and it is only used by some tools that wrap classes into other languages.
Additional options for uic when using AUTOUIC
This property holds additional command line options which will be used when uic is executed during the build via AUTOUIC, i.e. it is equivalent to the optional OPTIONS argument of the qt4_wrap_ui() macro.
By default it is empty.
The options set on the .ui source file may override AUTOUIC_OPTIONS set on the target.
# ... set_property(SOURCE widget.ui PROPERTY AUTOUIC_OPTIONS "--no-protection") # ...
Additional options for rcc when using AUTORCC
This property holds additional command line options which will be used when rcc is executed during the build via AUTORCC, i.e. it is equivalent to the optional OPTIONS argument of the qt4_add_resources() macro.
By default it is empty.
The options set on the .qrc source file may override AUTORCC_OPTIONS set on the target.
# ... set_property(SOURCE resources.qrc PROPERTY AUTORCC_OPTIONS "--compress;9") # ...
Preprocessor definitions for compiling a source file.
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. Xcode does not support per-configuration definitions on source files.
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.
Contents of COMPILE_DEFINITIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. However, Xcode does not support per-config per-source settings, so expressions that depend on the build configuration are not allowed with that generator.
Generator expressions should be preferred instead of setting the alternative per-configuration property.
Additional flags to be added when compiling this source file.
The COMPILE_FLAGS property, managed as a string, sets additional compiler flags used to build source files. Use COMPILE_DEFINITIONS to pass additional preprocessor definitions.
Contents of COMPILE_FLAGS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. However, Xcode does not support per-config per-source settings, so expressions that depend on the build configuration are not allowed with that generator.
NOTE:
List of additional options to pass to the compiler.
This property holds a ;-list of options and will be added to the list of compile flags when this source file builds. Use COMPILE_DEFINITIONS to pass additional preprocessor definitions and INCLUDE_DIRECTORIES to pass additional include directories.
Contents of COMPILE_OPTIONS may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. However, Xcode does not support per-config per-source settings, so expressions that depend on the build configuration are not allowed with that generator.
NOTE:
If set to true then this is an object file.
If this property is set to true then the source file is really an object file and should not be compiled. It will still be linked into the target though.
Set to FIXED or FREE to indicate the Fortran source layout.
This property tells CMake whether a given Fortran source file uses fixed-format or free-format. CMake will pass the corresponding format flag to the compiler. Consider using the target-wide Fortran_FORMAT property if all source files in a target share the same format.
Is this source file generated as part of the build or CMake process.
Tells the internal CMake engine that a source file is generated by an outside process such as another build step, or the execution of CMake itself. This information is then used to exempt the file from any existence or validity checks. Generated files are created by the execution of commands such as add_custom_command() and file(GENERATE).
When a generated file created by an add_custom_command() command is explicitly listed as a source file for any target in the same directory scope (which usually means the same CMakeLists.txt file), CMake will automatically create a dependency to make sure the file is generated before building that target.
Generated sources may be hidden in some IDE tools, while in others they might be shown. For the special case of sources generated by CMake’s AUTOMOC or AUTORCC functionality, the AUTOGEN_SOURCE_GROUP, AUTOMOC_SOURCE_GROUP and AUTORCC_SOURCE_GROUP target properties may influence where the generated sources are grouped in the project’s file lists.
Is this source file only a header file.
A property on a source file that indicates if the source file is a header file with no associated implementation. This is set automatically based on the file extension and is used by CMake to determine if certain dependency information should be computed.
By setting this property to ON, you can disable compilation of the given source file, even if it should be compiled because it is part of the library’s/executable’s sources.
This is useful if you have some source files which you somehow pre-process, and then add these pre-processed sources via add_library() or add_executable(). Normally, in IDE, there would be no reference of the original sources, only of these pre-processed sources. So by setting this property for all the original source files to ON, and then either calling add_library() or add_executable() while passing both the pre-processed sources and the original sources, or by using target_sources() to add original source files will do exactly what would one expect, i.e. the original source files would be visible in IDE, and will not be built.
List of preprocessor include file search directories.
This property holds a ;-list of paths and will be added to the list of include directories when this source file builds. These directories will take precedence over directories defined at target level except for Xcode generator due to technical limitations.
Relative paths should not be added to this property directly.
Contents of INCLUDE_DIRECTORIES may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. However, Xcode does not support per-config per-source settings, so expressions that depend on the build configuration are not allowed with that generator.
Make the output file have the same extension as the source file.
If this property is set then the file extension of the output file will be the same as that of the source file. Normally the output file extension is computed based on the language of the source file, for example .cxx will go to a .o extension.
Specify a list of text labels associated with a source file.
This property has meaning only when the source file is listed in a target whose LABELS property is also set. No other semantics are currently specified.
What programming language is the file.
A property that can be set to indicate what programming language the source file is. If it is not set the language is determined based on the file extension. Typical values are CXX C etc. Setting this property for a file means this file will be compiled. Do not set this for headers or files that should not be compiled.
The full path to a source file.
A read only property on a SOURCE FILE that contains the full path to the source file.
Place a source file inside a Application Bundle (MACOSX_BUNDLE), Core Foundation Bundle (BUNDLE), or Framework Bundle (FRAMEWORK). It is applicable for macOS and iOS.
Executable targets with the MACOSX_BUNDLE property set are built as macOS or iOS application bundles on Apple platforms. Shared library targets with the FRAMEWORK property set are built as macOS or iOS frameworks on Apple platforms. Module library targets with the BUNDLE property set are built as macOS CFBundle bundles on Apple platforms. Source files listed in the target with this property set will be copied to a directory inside the bundle or framework content folder specified by the property value. For macOS Application Bundles the content folder is <name>.app/Contents. For macOS Frameworks the content folder is <name>.framework/Versions/<version>. For macOS CFBundles the content folder is <name>.bundle/Contents (unless the extension is changed). See the PUBLIC_HEADER, PRIVATE_HEADER, and RESOURCE target properties for specifying files meant for Headers, PrivateHeaders, or Resources directories.
If the specified location is equal to Resources, the resulting location will be the same as if the RESOURCE property had been used. If the specified location is a sub-folder of Resources, it will be placed into the respective sub-folder. Note: For iOS Apple uses a flat bundle layout where no Resources folder exist. Therefore CMake strips the Resources folder name from the specified location.
Additional files on which a compiled object file depends.
Specifies a ;-list of full-paths to files on which any object files compiled from this source file depend. On Makefile Generators and the Ninja generator an object file will be recompiled if any of the named files is newer than it. Visual Studio Generators and the Xcode generator cannot implement such compilation dependencies.
This property need not be used to specify the dependency of a source file on a generated header file that it includes. Although the property was originally introduced for this purpose, it is no longer necessary. If the generated header file is created by a custom command in the same target as the source file, the automatic dependency scanning process will recognize the dependency. If the generated header file is created by another target, an inter-target dependency should be created with the add_dependencies() command (if one does not already exist due to linking relationships).
Additional outputs for a Makefile rule.
Additional outputs created by compilation of this source file. If any of these outputs is missing the object will be recompiled. This is supported only on Makefile generators and will be ignored on other generators.
Exclude the source file from AUTOMOC, AUTOUIC and AUTORCC processing (for Qt projects).
For finer exclusion control see SKIP_AUTOMOC, SKIP_AUTOUIC and SKIP_AUTORCC.
# ... set_property(SOURCE file.h PROPERTY SKIP_AUTOGEN ON) # ...
Exclude the source file from AUTOMOC processing (for Qt projects).
For broader exclusion control see SKIP_AUTOGEN.
# ... set_property(SOURCE file.h PROPERTY SKIP_AUTOMOC ON) # ...
Exclude the source file from AUTORCC processing (for Qt projects).
For broader exclusion control see SKIP_AUTOGEN.
# ... set_property(SOURCE file.qrc PROPERTY SKIP_AUTORCC ON) # ...
Exclude the source file from AUTOUIC processing (for Qt projects).
SKIP_AUTOUIC can be set on C++ header and source files and on .ui files.
For broader exclusion control see SKIP_AUTOGEN.
# ... set_property(SOURCE file.h PROPERTY SKIP_AUTOUIC ON) set_property(SOURCE file.cpp PROPERTY SKIP_AUTOUIC ON) set_property(SOURCE widget.ui PROPERTY SKIP_AUTOUIC ON) # ...
Is this just a name for a rule.
If SYMBOLIC (boolean) is set to true the build system will be informed that the source file is not actually created on disk but instead used as a symbolic name for a build rule.
Sets the <CopyToOutputDirectory> tag for a source file in a Visual Studio project file. Valid values are Never, Always and PreserveNewest.
Visual Studio and CSharp source-file-specific configuration.
Tell the Visual Studio generator to set the source file tag <tagname> to a given value in the generated Visual Studio CSharp project. Ignored on other generators and languages. This property can be used to define dependencies between source files or set any other Visual Studio specific parameters.
Example usage:
set_source_files_property(<filename>
PROPERTIES
VS_CSHARP_DependentUpon <other file>
VS_CSHARP_SubType "Form")
Mark a source file as content for deployment with a Windows Phone or Windows Store application when built with a Visual Studio generator. The value must evaluate to either 1 or 0 and may use generator expressions to make the choice based on the build configuration. The .vcxproj file entry for the source file will be marked either DeploymentContent or ExcludedFromBuild for values 1 and 0, respectively.
Specifies the deployment location for a content source file with a Windows Phone or Windows Store application when built with a Visual Studio generator. This property is only applicable when using VS_DEPLOYMENT_CONTENT. The value represent the path relative to the app package and applies to all configurations.
Boolean property to specify if the file should be included within a VSIX extension package. This is needed for development of Visual Studio extensions.
This property allows to specify the resource generator to be used on this file. It defaults to PublicResXFileCodeGenerator if not set.
This property only applies to C# projects.
Disable compiler optimizations for an .hlsl source file. This adds the -Od flag to the command line for the FxCompiler tool. Specify the value true for this property to disable compiler optimizations.
Enable debugging information for an .hlsl source file. This adds the -Zi flag to the command line for the FxCompiler tool. Specify the value true to generate debugging information for the compiled shader.
Specifies the name of the entry point for the shader of a .hlsl source file.
Set additional VS shader flags of a .hlsl source file.
Specifies the shader model of a .hlsl source file. Some shader types can only be used with recent shader models
Specifies a file name for the compiled shader object file for an .hlsl source file. This adds the -Fo flag to the command line for the FxCompiler tool.
Set filename for output header file containing object code of a .hlsl source file.
Set the VS shader type of a .hlsl source file.
Set name of variable in header file containing object code of a .hlsl source file.
Override the default Visual Studio tool that will be applied to the source file with a new tool not based on the extension of the file.
Mark a XAML source file as a different type than the default Page. The most common usage would be to set the default App.xaml file as ApplicationDefinition.
Exclude this source file from any code wrapping techniques.
Some packages can wrap source files into alternate languages to provide additional functionality. For example, C++ code can be wrapped into Java or Python etc using SWIG etc. If WRAP_EXCLUDE is set to true (1 etc) that indicates that this source file should not be wrapped.
Set the Xcode explicitFileType attribute on its reference to a source file. CMake computes a default based on file extension but can be told explicitly with this property.
See also XCODE_LAST_KNOWN_FILE_TYPE.
Add values to the Xcode ATTRIBUTES setting on its reference to a source file. Among other things, this can be used to set the role on a mig file:
set_source_files_properties(defs.mig
PROPERTIES
XCODE_FILE_ATTRIBUTES "Client;Server" )
Set the Xcode lastKnownFileType attribute on its reference to a source file. CMake computes a default based on file extension but can be told explicitly with this property.
See also XCODE_EXPLICIT_FILE_TYPE, which is preferred over this property if set.
True if entry should be hidden by default in GUIs.
This is a boolean value indicating whether the entry is considered interesting only for advanced configuration. The mark_as_advanced() command modifies this property.
Help associated with entry in GUIs.
This string summarizes the purpose of an entry to help users set it through a CMake GUI.
Internal management property. Do not set or get.
This is an internal cache entry property managed by CMake to track interactive user modification of entries. Ignore it.
Enumerate possible STRING entry values for GUI selection.
For cache entries with type STRING, this enumerates a set of values. CMake GUIs may use this to provide a selection widget instead of a generic string entry field. This is for convenience only. CMake does not enforce that the value matches one of those listed.
Widget type for entry in GUIs.
Cache entry values are always strings, but CMake GUIs present widgets to help users set values. The GUIs use this property as a hint to determine the widget type. Valid TYPE values are:
BOOL = Boolean ON/OFF value. PATH = Path to a directory. FILEPATH = Path to a file. STRING = Generic string value. INTERNAL = Do not present in GUI at all. STATIC = Value managed by CMake, do not change. UNINITIALIZED = Type not yet specified.
Generally the TYPE of a cache entry should be set by the command which creates it (set, option, find_library, etc.).
Value of a cache entry.
This property maps to the actual value of a cache entry. Setting this property always sets the value without checking, so use with care.
Species a list of shortcut names that should be created on the Desktop for this file.
The property is currently only supported by the WIX generator.
Request that this file not be overwritten on install or reinstall.
The property is currently only supported by the WIX generator.
Request that this file not be removed on uninstall.
The property is currently only supported by the WIX generator.
Species a list of shortcut names that should be created in the Start Menu for this file.
The property is currently only supported by the WIX generator.
Species a list of shortcut names that should be created in the Startup folder for this file.
The property is currently only supported by the WIX generator.
Specifies access permissions for files or directories installed by a WiX installer.
The property can contain multiple list entries, each of which has to match the following format.
<user>[@<domain>]=<permission>[,<permission>]
<user> and <domain> specify the windows user and domain for which the <Permission> element should be generated.
<permission> is any of the YesNoType attributes listed here:
http://wixtoolset.org/documentation/manual/v3/xsd/wix/permission.html
Ignored. See CMake Policy CMP0043.
Per-configuration preprocessor definitions in a directory.
This is the configuration-specific version of COMPILE_DEFINITIONS where <CONFIG> is an upper-case name (ex. COMPILE_DEFINITIONS_DEBUG).
This property will be initialized in each directory by its value in the directory’s parent.
Contents of COMPILE_DEFINITIONS_<CONFIG> may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
Generator expressions should be preferred instead of setting this property.
Deprecated. Use TEST_INCLUDE_FILES instead.
A cmake file that will be included when ctest is run.
If you specify TEST_INCLUDE_FILE, that file will be included and processed when ctest is run on the directory.
Ignored. See CMake Policy CMP0043.
Per-configuration preprocessor definitions on a target.
This is the configuration-specific version of COMPILE_DEFINITIONS where <CONFIG> is an upper-case name (ex. COMPILE_DEFINITIONS_DEBUG).
Contents of COMPILE_DEFINITIONS_<CONFIG> may use “generator expressions” with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.
Generator expressions should be preferred instead of setting this property.
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.
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.
Ignored. See CMake Policy CMP0043.
Per-configuration preprocessor definitions on a source file.
This is the configuration-specific version of COMPILE_DEFINITIONS. Note that Xcode does not support per-configuration source file flags so this property will be ignored by the Xcode generator.
2000-2019 Kitware, Inc. and Contributors
| February 10, 2019 | 3.13.4 |