diff options
| author | Brad King <brad.king@kitware.com> | 2015-01-08 18:36:11 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-01-08 18:43:40 (GMT) |
| commit | 7a2c3f0c0ec5b542c89456826adeb56c3cbd7df0 (patch) | |
| tree | 835790350dac4c32be88ccf5f94037e832e6b49c /Help/command/if.rst | |
| parent | c118816d44e178e4364a0c32aaece81a14511237 (diff) | |
| download | CMake-7a2c3f0c0ec5b542c89456826adeb56c3cbd7df0.zip CMake-7a2c3f0c0ec5b542c89456826adeb56c3cbd7df0.tar.gz CMake-7a2c3f0c0ec5b542c89456826adeb56c3cbd7df0.tar.bz2 | |
Help: Clarify if(<variable>) documentation (#15335)
When the variable is not defined the signature is actually accepting
a string. Also clarify fall-through from if(<constant>) case.
Diffstat (limited to 'Help/command/if.rst')
| -rw-r--r-- | Help/command/if.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Help/command/if.rst b/Help/command/if.rst index 79e5d21..d50b14c 100644 --- a/Help/command/if.rst +++ b/Help/command/if.rst @@ -42,11 +42,12 @@ Possible expressions are: or a non-zero number. False if the constant is ``0``, ``OFF``, ``NO``, ``FALSE``, ``N``, ``IGNORE``, ``NOTFOUND``, the empty string, or ends in the suffix ``-NOTFOUND``. Named boolean constants are - case-insensitive. If the argument is not one of these constants, it - is treated as a variable. + case-insensitive. If the argument is not one of these specific + constants, it is treated as a variable or string and the following + signature is used. -``if(<variable>)`` - True if the variable is defined to a value that is not a false +``if(<variable|string>)`` + True if given a variable that is defined to a value that is not a false constant. False otherwise. (Note macro arguments are not variables.) ``if(NOT <expression>)`` |