summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-01-10 17:14:56 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2015-01-10 17:14:56 (GMT)
commit427d9324983ddd02d5afff780c6b23ab5081c8df (patch)
tree41d22b30eb5605d713e9cc12c42c4db389b37b41 /Help
parentccd004666750248ba0fc5193ebefd45f93c12693 (diff)
parent7a2c3f0c0ec5b542c89456826adeb56c3cbd7df0 (diff)
downloadCMake-427d9324983ddd02d5afff780c6b23ab5081c8df.zip
CMake-427d9324983ddd02d5afff780c6b23ab5081c8df.tar.gz
CMake-427d9324983ddd02d5afff780c6b23ab5081c8df.tar.bz2
Merge topic 'doc-if-variable-not-defined'
7a2c3f0c Help: Clarify if(<variable>) documentation (#15335)
Diffstat (limited to 'Help')
-rw-r--r--Help/command/if.rst9
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>)``