mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-05-04 05:10:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help: Improve formatting of command documentation

Browse Source 
Use inline reStructuredText markup and add cross-references in more
places.
This commit is contained in:
Michael Scott
2015-06-04 22:51:22 +01:00
committed by Brad King
parent d17aa60659
commit c3f40f4fd9
59 changed files with 352 additions and 345 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/command/variable_requires.rst
+4 -4
View File
@@ -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.