reactos/CMake
1
0
Fork 0
mirror of https://github.com/reactos/CMake.git synced 2025-02-23 13:32:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge topic 'tweak_unset_docs'

Browse Source 
1a0f1a25a4 Help: Clarify the unset command

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2300
This commit is contained in:
Craig Scott 2018-08-23 11:53:08 +00:00 committed by Kitware Robot
commit 91c9a52273
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Help/command/unset.rst
View File

@ -7,9 +7,16 @@ Unset a variable, cache variable, or environment variable.
unset(<variable> [CACHE | PARENT_SCOPE])
Removes the specified variable causing it to become undefined. If
``CACHE`` is present then the variable is removed from the cache instead
of the current 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. 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.
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