reactos/CMake
1
0
Fork 0
mirror of https://github.com/reactos/CMake.git synced 2025-02-12 14:58:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Help: short/long variable reference in if command

Browse Source 
Explain that the short form of variable references
in the if command does not apply to ENV and CACHE vars.
This commit is contained in:
Joachim Wuttke (l) 2018-11-01 11:13:03 +01:00 committed by Joachim Wuttke (h)
parent 85498fccd8
commit 8ba2a8d4a4
2 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Help/command/if.rst
View File

@ -231,7 +231,7 @@ which is true because ``var2`` is defined to "var1" which is not a false
constant.
Automatic evaluation applies in the other cases whenever the
above-documented signature accepts ``<variable|string>``:
above-documented condition syntax accepts ``<variable|string>``:
* The left hand argument to ``MATCHES`` is first checked to see if it is
a defined variable, if so the variable's value is used, otherwise the
@ -269,3 +269,7 @@ specified in a :ref:`Quoted Argument` or a :ref:`Bracket Argument`.
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>.

12
Help/manual/cmake-language.7.rst
View File

@ -389,7 +389,7 @@ historical considerations.)
Variable References
-------------------
A *variable reference* has the form ``${variable_name}`` and is
A *variable reference* has the form ``${<variable>}`` and is
evaluated inside a `Quoted Argument`_ or an `Unquoted Argument`_.
A variable reference is replaced by the value of the variable,
or by the empty string if the variable is not set.
@ -405,12 +405,18 @@ the ``$`` is also technically permitted but is discouraged.
The `Variables`_ section documents the scope of variable names
and how their values are set.
An *environment variable reference* has the form ``$ENV{VAR}``.
An *environment variable reference* has the form ``$ENV{<variable>}``.
See the `Environment Variables`_ section for more information.
A *cache variable reference* has the form ``$CACHE{VAR}``.
A *cache variable reference* has the form ``$CACHE{<variable>}``.
See :variable:`CACHE` for more information.
The :command:`if` command has a special condition syntax that
allows for variable references in the short form ``<variable>``
instead of ``${<variable>}``.
However, environment and cache variables always need to be
referenced as ``$ENV{<variable>}`` or ``$CACHE{<variable>}``.
Comments
--------