512f64289a
Also call out possible exposure of an existing cache entry of the same
name, as we have for the `unset` command since commit 1a0f1a25a4 (Help:
Clarify the unset command, 2018-08-17, v3.13.0-rc1~199^2).
Issue: #24633
42 lines
1.1 KiB
ReStructuredText
42 lines
1.1 KiB
ReStructuredText
unset
|
|
-----
|
|
|
|
Unset a variable, cache variable, or environment variable.
|
|
|
|
Unset Normal Variable or Cache Entry
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. code-block:: cmake
|
|
|
|
unset(<variable> [CACHE | PARENT_SCOPE])
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
.. include:: UNSET_NOTE.txt
|
|
|
|
Unset Environment Variable
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
.. code-block:: cmake
|
|
|
|
unset(ENV{<variable>})
|
|
|
|
Removes ``<variable>`` from the currently available
|
|
:manual:`Environment Variables <cmake-env-variables(7)>`.
|
|
Subsequent calls of ``$ENV{<variable>}`` will return the empty string.
|
|
|
|
This command affects only the current CMake process, not the process
|
|
from which CMake was called, nor the system environment at large,
|
|
nor the environment of subsequent build or test processes.
|
|
|
|
See Also
|
|
^^^^^^^^
|
|
|
|
* :command:`set`
|