diff options
| author | Michael Scott <michael.scott250@gmail.com> | 2015-06-04 21:51:22 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-06-08 20:28:31 (GMT) |
| commit | c3f40f4fd98388a2fd31c707e7225d33a7fc76f6 (patch) | |
| tree | 4b76a32ab9bf416fe1b5d5bd60bc68e1f267b3a7 /Help/command/variable_requires.rst | |
| parent | d17aa60659a1a69f9101c61a149eca5842291226 (diff) | |
| download | CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.zip CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.gz CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.bz2 | |
Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more
places.
Diffstat (limited to 'Help/command/variable_requires.rst')
| -rw-r--r-- | Help/command/variable_requires.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Help/command/variable_requires.rst b/Help/command/variable_requires.rst index 831dd00..9cf9f3f 100644 --- a/Help/command/variable_requires.rst +++ b/Help/command/variable_requires.rst @@ -3,7 +3,7 @@ variable_requires Disallowed. See CMake Policy :policy:`CMP0035`. -Use the if() command instead. +Use the :command:`if` command instead. Assert satisfaction of an option's required variables. @@ -13,10 +13,10 @@ Assert satisfaction of an option's required variables. REQUIRED_VARIABLE1 REQUIRED_VARIABLE2 ...) -The first argument (TEST_VARIABLE) is the name of the variable to be +The first argument (``TEST_VARIABLE``) is the name of the variable to be tested, if that variable is false nothing else is done. If -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. +``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. 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. |