summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorJoachim Wuttke (h) <j.wuttke@fz-juelich.de>2018-11-01 21:26:32 (GMT)
committerJoachim Wuttke (h) <j.wuttke@fz-juelich.de>2018-11-08 19:30:05 (GMT)
commite855bd5248bbb7b77b45e269e4fa098b29c9e889 (patch)
treefc9babeef5972838a1cf13753f53f3e6eeedc0c7 /Help
parent8ba2a8d4a415d2288786a0d56e90b3d7693ad32e (diff)
downloadCMake-e855bd5248bbb7b77b45e269e4fa098b29c9e889.zip
CMake-e855bd5248bbb7b77b45e269e4fa098b29c9e889.tar.gz
CMake-e855bd5248bbb7b77b45e269e4fa098b29c9e889.tar.bz2
Help: Document if(DEFINED ENV{name})
Diffstat (limited to 'Help')
-rw-r--r--Help/command/if.rst16
1 files changed, 9 insertions, 7 deletions
diff --git a/Help/command/if.rst b/Help/command/if.rst
index ea5de7f..1cd9965 100644
--- a/Help/command/if.rst
+++ b/Help/command/if.rst
@@ -187,10 +187,11 @@ Possible conditions are:
``if(<variable|string> IN_LIST <variable>)``
True if the given element is contained in the named list variable.
-``if(DEFINED <variable>)``
- True if the given variable is defined. It does not matter if the
- variable is true or false just if it has been set. (Note macro
- arguments are not variables.)
+``if(DEFINED <name>|ENV{<name>})``
+ True if a variable or environment variable
+ with given ``<name>`` is defined.
+ The value of the variable does not matter.
+ Note that macro arguments are not variables.
``if((condition) AND (condition OR (condition)))``
The conditions inside the parenthesis are evaluated first and then
@@ -270,6 +271,7 @@ A quoted or bracketed variable or keyword will be interpreted as a
string and not dereferenced or interpreted.
See policy :policy:`CMP0054`.
-There is no short form for environment or cache :ref:`Variable References`.
-They can be referenced as ``$ENV{<name>}`` or ``$CACHE{<name>}``
-wherever the above-documented condition syntax accepts <variable|string>.
+There is no automatic evaluation for environment or cache
+:ref:`Variable References`. Their values must be referenced as
+``$ENV{<name>}`` or ``$CACHE{<name>}`` wherever the above-documented
+condition syntax accepts ``<variable|string>``.