cmake/Help/command/unset.rst

33 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2014-08-03 19:52:23 +02:00
unset
-----
Unset a variable, cache variable, or environment variable.
::
unset(<variable> [CACHE | PARENT_SCOPE])
2018-10-28 12:09:07 +01:00
Removes a normal variable from the current scope, causing it
to become undefined. If ``CACHE`` is present, then a cache variable
is removed instead of a normal variable. Note that when evaluating
:ref:`Variable References` of the form ``${VAR}``, CMake first searches
for a normal variable with that name. If no such normal variable exists,
CMake will then search for a cache entry with that name. Because of this
unsetting a normal variable can expose a cache variable that was previously
hidden. To force a variable reference of the form ``${VAR}`` to return an
empty string, use ``set(<variable> "")``, which clears the normal variable
but leaves it defined.
2014-08-03 19:52:23 +02:00
2015-11-17 17:22:37 +01:00
If ``PARENT_SCOPE`` is present then the variable is removed from the scope
above the current scope. See the same option in the :command:`set` command
for further details.
2014-08-03 19:52:23 +02:00
2015-11-17 17:22:37 +01:00
``<variable>`` can be an environment variable such as:
2014-08-03 19:52:23 +02:00
::
unset(ENV{LD_LIBRARY_PATH})
in which case the variable will be removed from the current
environment.