diff options
Diffstat (limited to 'Help/command/variable_requires.rst')
| -rw-r--r-- | Help/command/variable_requires.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/Help/command/variable_requires.rst b/Help/command/variable_requires.rst new file mode 100644 index 0000000000..7535e40924 --- /dev/null +++ b/Help/command/variable_requires.rst @@ -0,0 +1,20 @@ +variable_requires +----------------- + +Deprecated. Use the if() command instead. + +Assert satisfaction of an option's required variables. + +:: + + variable_requires(TEST_VARIABLE RESULT_VARIABLE + REQUIRED_VARIABLE1 + REQUIRED_VARIABLE2 ...) + +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. +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. |