diff options
20 files changed, 128 insertions, 1219 deletions
diff --git a/Help/command/add_compile_options.rst b/Help/command/add_compile_options.rst index f086e57..a9329f4 100644 --- a/Help/command/add_compile_options.rst +++ b/Help/command/add_compile_options.rst @@ -13,77 +13,5 @@ alternative commands exist to add preprocessor definitions or include directories. See documentation of the directory and target COMPILE_OPTIONS properties for details. Arguments to add_compile_options may use "generator expressions" with the syntax -"$<...>". Generator expressions are evaluated during build system -generation to produce information specific to each build -configuration. Valid expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +"$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. diff --git a/Help/command/add_custom_command.rst b/Help/command/add_custom_command.rst index cf1661f..4de708f 100644 --- a/Help/command/add_custom_command.rst +++ b/Help/command/add_custom_command.rst @@ -113,56 +113,8 @@ dependency that would cause the custom command to re-run whenever the executable is recompiled. Arguments to COMMAND may use "generator expressions" with the syntax -"$<...>". Generator expressions are evaluated during build system -generation to produce information specific to each build -configuration. Valid expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. +"$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. Note that tgt is not added as a dependency of the target this expression is evaluated on. diff --git a/Help/command/add_test.rst b/Help/command/add_test.rst index 335db73..7363d5f 100644 --- a/Help/command/add_test.rst +++ b/Help/command/add_test.rst @@ -34,57 +34,9 @@ executed only when testing under one of the named configurations. If a WORKING_DIRECTORY option is given then the test will be executed in the given directory. -Arguments after COMMAND may use "generator expressions" with the -syntax "$<...>". Generator expressions are evaluated during build -system generation to produce information specific to each build -configuration. Valid expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. +Arguments after COMMAND may use "generator expressions" with the syntax +"$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. Note that tgt is not added as a dependency of the target this expression is evaluated on. diff --git a/Help/command/target_compile_definitions.rst b/Help/command/target_compile_definitions.rst index 0746d2a..5c223a2 100644 --- a/Help/command/target_compile_definitions.rst +++ b/Help/command/target_compile_definitions.rst @@ -19,78 +19,6 @@ property of <target>. The following arguments specify compile definitions. Repeated calls for the same <target> append items in the order called. -Arguments to target_compile_definitions may use "generator -expressions" with the syntax "$<...>". Generator expressions are -evaluated during build system generation to produce information -specific to each build configuration. Valid expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +Arguments to target_compile_definitions may use "generator expressions" with +the syntax "$<...>". See the :manual:`cmake-generator-expressions(7)` manual +for available expressions. diff --git a/Help/command/target_compile_options.rst b/Help/command/target_compile_options.rst index e086d5a..88a4ea3 100644 --- a/Help/command/target_compile_options.rst +++ b/Help/command/target_compile_options.rst @@ -22,77 +22,6 @@ of <target>. The following arguments specify compile opitions. Repeated calls for the same <target> append items in the order called. Arguments to target_compile_options may use "generator expressions" -with the syntax "$<...>". Generator expressions are evaluated during -build system generation to produce information specific to each build -configuration. Valid expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +with the syntax "$<...>". +See the :manual:`cmake-generator-expressions(7)` manual for available +expressions. diff --git a/Help/command/target_include_directories.rst b/Help/command/target_include_directories.rst index 63306cd..4835b96 100644 --- a/Help/command/target_include_directories.rst +++ b/Help/command/target_include_directories.rst @@ -32,77 +32,6 @@ INTERFACE_SYSTEM_INCLUDE_DIRECTORIES target property will be populated with the specified directories. Arguments to target_include_directories may use "generator -expressions" with the syntax "$<...>". Generator expressions are -evaluated during build system generation to produce information -specific to each build configuration. Valid expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +expressions" with the syntax "$<...>". +See the :manual:`cmake-generator-expressions(7)` manual for available +expressions. diff --git a/Help/command/target_link_libraries.rst b/Help/command/target_link_libraries.rst index 049d465..a1e3e22 100644 --- a/Help/command/target_link_libraries.rst +++ b/Help/command/target_link_libraries.rst @@ -138,78 +138,5 @@ into a single archive.) Arguments to target_link_libraries may use "generator expressions" with the syntax "$<...>". Note however, that generator expressions will not be used in OLD handling of CMP0003 or CMP0004. - -Generator expressions are evaluated during build system generation to -produce information specific to each build configuration. Valid -expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +See the :manual:`cmake-generator-expressions(7)` manual for available +expressions. diff --git a/Help/index.rst b/Help/index.rst index 4136808..7db0be6 100644 --- a/Help/index.rst +++ b/Help/index.rst @@ -19,6 +19,7 @@ CMake Reference Documentation /manual/cmake-policies.7 /manual/cmake-properties.7 /manual/cmake-variables.7 + /manual/cmake-generator-expressions.7 .. only:: html diff --git a/Help/manual/cmake-generator-expressions.7.rst b/Help/manual/cmake-generator-expressions.7.rst new file mode 100644 index 0000000..849ee36 --- /dev/null +++ b/Help/manual/cmake-generator-expressions.7.rst @@ -0,0 +1,84 @@ +cmake-generator-expressions(7) +****************************** + +.. only:: html or latex + + .. contents:: + +Generator Expressions +===================== + +Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/prop_dir/COMPILE_OPTIONS.rst b/Help/prop_dir/COMPILE_OPTIONS.rst index 821b4f6..e8d1b8a 100644 --- a/Help/prop_dir/COMPILE_OPTIONS.rst +++ b/Help/prop_dir/COMPILE_OPTIONS.rst @@ -9,78 +9,6 @@ property. This property exists on directories and targets. The target property values are used by the generators to set the options for the compiler. -Contents of COMPILE_OPTIONS may use "generator expressions" with the -syntax "$<...>". Generator expressions are evaluated during build -system generation to produce information specific to each build -configuration. Valid expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +Contents of COMPILE_OPTIONS may use "generator expressions" with the syntax +"$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. diff --git a/Help/prop_tgt/COMPILE_DEFINITIONS.rst b/Help/prop_tgt/COMPILE_DEFINITIONS.rst index b6999fc..51bdb92 100644 --- a/Help/prop_tgt/COMPILE_DEFINITIONS.rst +++ b/Help/prop_tgt/COMPILE_DEFINITIONS.rst @@ -16,80 +16,8 @@ CMake will automatically drop some definitions that are not supported by the native build tool. The VS6 IDE does not support definition values with spaces (but NMake does). -Contents of COMPILE_DEFINITIONS may use "generator expressions" with -the syntax "$<...>". Generator expressions are evaluated during build -system generation to produce information specific to each build -configuration. Valid expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +Contents of COMPILE_DEFINITIONS may use "generator expressions" with the +syntax "$<...>". See the :manual:`cmake-generator-expressions(7)` manual +for available expressions. .. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt diff --git a/Help/prop_tgt/COMPILE_OPTIONS.rst b/Help/prop_tgt/COMPILE_OPTIONS.rst index d0b6368..80e0ccb 100644 --- a/Help/prop_tgt/COMPILE_OPTIONS.rst +++ b/Help/prop_tgt/COMPILE_OPTIONS.rst @@ -10,77 +10,5 @@ The target property values are used by the generators to set the options for the compiler. Contents of COMPILE_OPTIONS may use "generator expressions" with the -syntax "$<...>". Generator expressions are evaluated during build -system generation to produce information specific to each build -configuration. Valid expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +syntax "$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. diff --git a/Help/prop_tgt/INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INCLUDE_DIRECTORIES.rst index 0e13e12..40709a4 100644 --- a/Help/prop_tgt/INCLUDE_DIRECTORIES.rst +++ b/Help/prop_tgt/INCLUDE_DIRECTORIES.rst @@ -17,78 +17,6 @@ The target property values are used by the generators to set the include paths for the compiler. See also the include_directories command. -Contents of INCLUDE_DIRECTORIES may use "generator expressions" with -the syntax "$<...>". Generator expressions are evaluated during build -system generation to produce information specific to each build -configuration. Valid expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +Contents of INCLUDE_DIRECTORIES may use "generator expressions" with the +syntax "$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. diff --git a/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst b/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst index 7221c6b..eb001dd 100644 --- a/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst +++ b/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst @@ -9,77 +9,5 @@ targets can add entries to their own COMPILE_DEFINITIONS property such as $<TARGET_PROPERTY:foo,INTERFACE_COMPILE_DEFINITIONS> to use the compile definitions specified in the interface of 'foo'. -Generator expressions are evaluated during build system generation to -produce information specific to each build configuration. Valid -expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +This property also supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst b/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst index 99b5173..51b1f6e 100644 --- a/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst +++ b/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst @@ -9,77 +9,5 @@ targets can add entries to their own COMPILE_OPTIONS property such as $<TARGET_PROPERTY:foo,INTERFACE_COMPILE_OPTIONS> to use the compile options specified in the interface of 'foo'. -Generator expressions are evaluated during build system generation to -produce information specific to each build configuration. Valid -expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +This property also supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst index 9d8dc8d..33892da 100644 --- a/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst +++ b/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst @@ -9,77 +9,5 @@ targets can add entries to their own INCLUDE_DIRECTORIES property such as $<TARGET_PROPERTY:foo,INTERFACE_INCLUDE_DIRECTORIES> to use the include directories specified in the interface of 'foo'. -Generator expressions are evaluated during build system generation to -produce information specific to each build configuration. Valid -expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +This property also supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst index e272ee9..24c2441 100644 --- a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst +++ b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst @@ -10,79 +10,5 @@ other target also. This property is overriden by the LINK_INTERFACE_LIBRARIES or LINK_INTERFACE_LIBRARIES_<CONFIG> property if policy CMP0022 is OLD or unset. - - -Generator expressions are evaluated during build system generation to -produce information specific to each build configuration. Valid -expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +This property also supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst index 41b43e4..9a6e3a9 100644 --- a/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst +++ b/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst @@ -8,77 +8,5 @@ which contain system headers, and therefore should not result in compiler warnings. Consuming targets will then mark the same include directories as system headers. -Generator expressions are evaluated during build system generation to -produce information specific to each build configuration. Valid -expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +This property also supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/Help/prop_tgt/LINK_LIBRARIES.rst b/Help/prop_tgt/LINK_LIBRARIES.rst index 3095d5d..b18fe30 100644 --- a/Help/prop_tgt/LINK_LIBRARIES.rst +++ b/Help/prop_tgt/LINK_LIBRARIES.rst @@ -12,78 +12,6 @@ The target property values are used by the generators to set the link libraries for the compiler. See also the target_link_libraries command. -Contents of LINK_LIBRARIES may use "generator expressions" with the -syntax "$<...>". Generator expressions are evaluated during build -system generation to produce information specific to each build -configuration. Valid expressions are: - -:: - - $<0:...> = empty string (ignores "...") - $<1:...> = content of "..." - $<CONFIG:cfg> = '1' if config is "cfg", else '0' - $<CONFIGURATION> = configuration name - $<BOOL:...> = '1' if the '...' is true, else '0' - $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' - $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. - $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. - $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. - $<JOIN:list,...> = joins the list with the content of "..." - $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. - $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. - $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. - $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. - $<C_COMPILER_ID> = The CMake-id of the C compiler used. - $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. - $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. - $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. - $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. - $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. - $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. - $<C_COMPILER_VERSION> = The version of the C compiler used. - $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. - $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. - $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. - $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) - $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) - $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) - -where "tgt" is the name of a target. Target file expressions produce -a full path, but _DIR and _NAME versions can produce the directory and -file name components: - -:: - - $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> - $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> - $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> - - - -:: - - $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. - -Note that tgt is not added as a dependency of the target this -expression is evaluated on. - -:: - - $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. - $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. - -Boolean expressions: - -:: - - $<AND:?[,?]...> = '1' if all '?' are '1', else '0' - $<OR:?[,?]...> = '0' if all '?' are '0', else '1' - $<NOT:?> = '0' if '?' is '1', else '1' - -where '?' is always either '0' or '1'. - -Expressions with an implicit 'this' target: - -:: - - $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. +Contents of LINK_LIBRARIES may use "generator expressions" with the syntax +"$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. diff --git a/Utilities/Sphinx/conf.py.in b/Utilities/Sphinx/conf.py.in index e18ae74..6c9cd77 100644 --- a/Utilities/Sphinx/conf.py.in +++ b/Utilities/Sphinx/conf.py.in @@ -39,6 +39,7 @@ man_pages = [ ('manual/cmake-policies.7', 'cmake-policies', 'CMake Policies Reference', [], 7), ('manual/cmake-properties.7', 'cmake-properties', 'CMake Properties Reference', [], 7), ('manual/cmake-variables.7', 'cmake-variables', 'CMake Variables Reference', [], 7), + ('manual/cmake-generator-expressions.7', 'cmake-generator-expressions', 'CMake Generator Expressions', [], 7), ] man_show_urls = False |