diff options
author | Brad King <brad.king@kitware.com> | 2021-01-14 18:33:34 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2021-01-14 18:40:04 (GMT) |
commit | 501bcb6327414dffff0923748a26d8fe9acd7268 (patch) | |
tree | 35280b1fc5c876f85dc49ebef0df4b4d8535fd2a | |
parent | 1c4c742f409b13e63f8661a098f4a6a11a92fe9c (diff) | |
download | CMake-501bcb6327414dffff0923748a26d8fe9acd7268.zip CMake-501bcb6327414dffff0923748a26d8fe9acd7268.tar.gz CMake-501bcb6327414dffff0923748a26d8fe9acd7268.tar.bz2 |
Help: Add section heading for macro expansion in cmake-presets(7)
Also cross-reference it from the prose.
-rw-r--r-- | Help/manual/cmake-presets.7.rst | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index ce9d1a6..1d990a1 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/Help/manual/cmake-presets.7.rst @@ -162,8 +162,8 @@ The root object recognizes the following fields: ``binaryDir`` An optional string representing the path to the output binary directory. - This field supports macro expansion. If a relative path is specified, it - is calculated relative to the source directory. If ``binaryDir`` is not + This field supports `macro expansion`_. If a relative path is specified, + it is calculated relative to the source directory. If ``binaryDir`` is not specified, it must be inherited from the ``inherits`` preset (unless this preset is ``hidden``). @@ -179,7 +179,7 @@ The root object recognizes the following fields: may not be an empty string), and the value is either ``null``, a boolean (which is equivalent to a value of ``"TRUE"`` or ``"FALSE"`` and a type of ``BOOL``), a string representing the value of the variable (which - supports macro expansion), or an object with the following fields: + supports `macro expansion`_), or an object with the following fields: ``type`` @@ -189,7 +189,7 @@ The root object recognizes the following fields: A required string or boolean representing the value of the variable. A boolean is equivalent to ``"TRUE"`` or ``"FALSE"``. This field - supports macro expansion. + supports `macro expansion`_. Cache variables are inherited through the ``inherits`` field, and the preset's variables will be the union of its own ``cacheVariables`` and @@ -204,7 +204,7 @@ The root object recognizes the following fields: (which may not be an empty string), and the value is either ``null`` or a string representing the value of the variable. Each variable is set regardless of whether or not a value was given to it by the process's - environment. This field supports macro expansion, and environment + environment. This field supports `macro expansion`_, and environment variables in this map may reference each other, and may be listed in any order, as long as such references do not cause a cycle (for example, if ``ENV_1`` is ``$env{ENV_2}``, ``ENV_2`` may not be ``$env{ENV_1}``.) @@ -285,6 +285,9 @@ The root object recognizes the following fields: An optional boolean. Setting this to ``true`` is equivalent to passing ``--debug-find`` on the command line. +Macro Expansion +^^^^^^^^^^^^^^^ + As mentioned above, some fields support macro expansion. Macros are recognized in the form ``$<macro-namespace>{<macro-name>}``. All macros are evaluated in the context of the preset being used, even if the macro is in a |