mirror of
https://github.com/Kitware/CMake.git
synced 2026-05-05 05:39:57 -05:00
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
This commit is contained in:
Kitware Robot
@@ -0,0 +1,7 @@
|
||||
ADDITIONAL_MAKE_CLEAN_FILES
|
||||
---------------------------
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,7 @@
|
||||
CACHE_VARIABLES
|
||||
---------------
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,7 @@
|
||||
CLEAN_NO_CUSTOM
|
||||
---------------
|
||||
|
||||
Should the output of custom commands be left.
|
||||
|
||||
If this is true then the outputs of custom commands for this directory
|
||||
will not be removed during the "make clean" stage.
|
||||
@@ -0,0 +1,39 @@
|
||||
COMPILE_DEFINITIONS
|
||||
-------------------
|
||||
|
||||
Preprocessor definitions for compiling a directory's sources.
|
||||
|
||||
The COMPILE_DEFINITIONS property may be set to a semicolon-separated
|
||||
list of preprocessor definitions using the syntax VAR or VAR=value.
|
||||
Function-style definitions are not supported. CMake will
|
||||
automatically escape the value correctly for the native build system
|
||||
(note that CMake language syntax may require escapes to specify some
|
||||
values). This property may be set on a per-configuration basis using
|
||||
the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case
|
||||
name (ex. "COMPILE_DEFINITIONS_DEBUG"). 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. The VS6 IDE does not support definition
|
||||
values with spaces (but NMake does).
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,8 @@
|
||||
COMPILE_DEFINITIONS_<CONFIG>
|
||||
----------------------------
|
||||
|
||||
Per-configuration preprocessor definitions in a directory.
|
||||
|
||||
This is the configuration-specific version of COMPILE_DEFINITIONS.
|
||||
This property will be initialized in each directory by its value in
|
||||
the directory's parent.
|
||||
@@ -0,0 +1,86 @@
|
||||
COMPILE_OPTIONS
|
||||
---------------
|
||||
|
||||
List of options to pass to the compiler.
|
||||
|
||||
This property specifies the list of directories given so far for this
|
||||
property. This property exists on directories and targets.
|
||||
|
||||
The target property values are used by the generators to set the
|
||||
options for the compiler.
|
||||
|
||||
Contents of COMPILE_OPTIONS may use "generator expressions" with the
|
||||
syntax "$<...>". Generator expressions are evaluated during build
|
||||
system generation to produce information specific to each build
|
||||
configuration. Valid expressions are:
|
||||
|
||||
::
|
||||
|
||||
$<0:...> = empty string (ignores "...")
|
||||
$<1:...> = content of "..."
|
||||
$<CONFIG:cfg> = '1' if config is "cfg", else '0'
|
||||
$<CONFIGURATION> = configuration name
|
||||
$<BOOL:...> = '1' if the '...' is true, else '0'
|
||||
$<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0'
|
||||
$<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example.
|
||||
$<COMMA> = A literal ','. Used to compare strings which contain a ',' for example.
|
||||
$<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'.
|
||||
$<JOIN:list,...> = joins the list with the content of "..."
|
||||
$<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions.
|
||||
$<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise.
|
||||
$<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise.
|
||||
$<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'.
|
||||
$<C_COMPILER_ID> = The CMake-id of the C compiler used.
|
||||
$<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'.
|
||||
$<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used.
|
||||
$<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'.
|
||||
$<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'.
|
||||
$<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'.
|
||||
$<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'.
|
||||
$<C_COMPILER_VERSION> = The version of the C compiler used.
|
||||
$<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'.
|
||||
$<CXX_COMPILER_VERSION> = The version of the CXX compiler used.
|
||||
$<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'.
|
||||
$<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a)
|
||||
$<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so)
|
||||
$<TARGET_SONAME_FILE:tgt> = file with soname (.so.3)
|
||||
|
||||
where "tgt" is the name of a target. Target file expressions produce
|
||||
a full path, but _DIR and _NAME versions can produce the directory and
|
||||
file name components:
|
||||
|
||||
::
|
||||
|
||||
$<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt>
|
||||
$<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt>
|
||||
$<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt>
|
||||
|
||||
|
||||
|
||||
::
|
||||
|
||||
$<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt.
|
||||
|
||||
Note that tgt is not added as a dependency of the target this
|
||||
expression is evaluated on.
|
||||
|
||||
::
|
||||
|
||||
$<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies.
|
||||
$<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise.
|
||||
|
||||
Boolean expressions:
|
||||
|
||||
::
|
||||
|
||||
$<AND:?[,?]...> = '1' if all '?' are '1', else '0'
|
||||
$<OR:?[,?]...> = '0' if all '?' are '0', else '1'
|
||||
$<NOT:?> = '0' if '?' is '1', else '1'
|
||||
|
||||
where '?' is always either '0' or '1'.
|
||||
|
||||
Expressions with an implicit 'this' target:
|
||||
|
||||
::
|
||||
|
||||
$<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated.
|
||||
@@ -0,0 +1,8 @@
|
||||
DEFINITIONS
|
||||
-----------
|
||||
|
||||
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 instead.
|
||||
@@ -0,0 +1,9 @@
|
||||
EXCLUDE_FROM_ALL
|
||||
----------------
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,34 @@
|
||||
IMPLICIT_DEPENDS_INCLUDE_TRANSFORM
|
||||
----------------------------------
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,18 @@
|
||||
INCLUDE_DIRECTORIES
|
||||
-------------------
|
||||
|
||||
List of preprocessor include file search directories.
|
||||
|
||||
This property specifies the list of directories given so far to the
|
||||
include_directories command. This property exists on directories and
|
||||
targets. In addition to accepting values from the include_directories
|
||||
command, values may be set directly on any directory or any target
|
||||
using the set_property command. A target gets its initial value for
|
||||
this property from the value of the directory property. A directory
|
||||
gets its initial value from its parent directory if it has one. Both
|
||||
directory and target property values are adjusted by calls to the
|
||||
include_directories command.
|
||||
|
||||
The target property values are used by the generators to set the
|
||||
include paths for the compiler. See also the include_directories
|
||||
command.
|
||||
@@ -0,0 +1,8 @@
|
||||
INCLUDE_REGULAR_EXPRESSION
|
||||
--------------------------
|
||||
|
||||
Include file scanning regular expression.
|
||||
|
||||
This read-only property specifies the regular expression used during
|
||||
dependency scanning to match include files that should be followed.
|
||||
See the include_regular_expression command.
|
||||
@@ -0,0 +1,7 @@
|
||||
INTERPROCEDURAL_OPTIMIZATION
|
||||
----------------------------
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,8 @@
|
||||
INTERPROCEDURAL_OPTIMIZATION_<CONFIG>
|
||||
-------------------------------------
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,8 @@
|
||||
LINK_DIRECTORIES
|
||||
----------------
|
||||
|
||||
List of linker search directories.
|
||||
|
||||
This read-only property specifies the list of directories given so far
|
||||
to the link_directories command. It is intended for debugging
|
||||
purposes.
|
||||
@@ -0,0 +1,9 @@
|
||||
LISTFILE_STACK
|
||||
--------------
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,8 @@
|
||||
MACROS
|
||||
------
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,8 @@
|
||||
PARENT_DIRECTORY
|
||||
----------------
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,7 @@
|
||||
RULE_LAUNCH_COMPILE
|
||||
-------------------
|
||||
|
||||
Specify a launcher for compile rules.
|
||||
|
||||
See the global property of the same name for details. This overrides
|
||||
the global property for a directory.
|
||||
@@ -0,0 +1,7 @@
|
||||
RULE_LAUNCH_CUSTOM
|
||||
------------------
|
||||
|
||||
Specify a launcher for custom rules.
|
||||
|
||||
See the global property of the same name for details. This overrides
|
||||
the global property for a directory.
|
||||
@@ -0,0 +1,7 @@
|
||||
RULE_LAUNCH_LINK
|
||||
----------------
|
||||
|
||||
Specify a launcher for link rules.
|
||||
|
||||
See the global property of the same name for details. This overrides
|
||||
the global property for a directory.
|
||||
@@ -0,0 +1,7 @@
|
||||
TEST_INCLUDE_FILE
|
||||
-----------------
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,7 @@
|
||||
VARIABLES
|
||||
---------
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,29 @@
|
||||
VS_GLOBAL_SECTION_POST_<section>
|
||||
--------------------------------
|
||||
|
||||
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 7 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.
|
||||
@@ -0,0 +1,22 @@
|
||||
VS_GLOBAL_SECTION_PRE_<section>
|
||||
-------------------------------
|
||||
|
||||
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 7 and above; it is ignored
|
||||
on other generators. The property only applies when set on a
|
||||
directory whose CMakeLists.txt contains a project() command.
|
||||
Reference in New Issue
Block a user