kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Help/command/variable_requires.rst

23 lines
743 B
ReStructuredText
Raw Normal View History

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.
2013-10-15 19:17:36 +04:00
variable_requires
-----------------
Add policy CMP0035 to disallow variable_requires
2013-10-21 19:58:48 +04:00
Disallowed. See CMake Policy :policy:`CMP0035`.
Help: Improve formatting of command documentation Use inline reStructuredText markup and add cross-references in more places.
2015-06-05 00:51:22 +03:00
Use the :command:`if` command instead.
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.
2013-10-15 19:17:36 +04:00
Assert satisfaction of an option's required variables.
::
variable_requires(TEST_VARIABLE RESULT_VARIABLE
REQUIRED_VARIABLE1
REQUIRED_VARIABLE2 ...)
Help: Improve formatting of command documentation Use inline reStructuredText markup and add cross-references in more places.
2015-06-05 00:51:22 +03:00
The first argument (``TEST_VARIABLE``) is the name of the variable to be
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.
2013-10-15 19:17:36 +04:00
tested, if that variable is false nothing else is done. If
Help: Improve formatting of command documentation Use inline reStructuredText markup and add cross-references in more places.
2015-06-05 00:51:22 +03:00
``TEST_VARIABLE`` is true, then the next argument (``RESULT_VARIABLE``)
is a variable that is set to true if all the required variables are set.
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.
2013-10-15 19:17:36 +04:00
The rest of the arguments are variables that must be true or not set
to NOTFOUND to avoid an error. If any are not true, an error is
reported.