diff options
author | Craig Scott <craig.scott@crascit.com> | 2018-08-23 11:53:08 +0000 |
---|---|---|
committer | Kitware Robot <kwrobot@kitware.com> | 2018-08-23 07:53:19 -0400 |
commit | 91c9a5227384b374c80f1e6453bb830e3de68a4a (patch) | |
tree | 62615e45e580daf0ba46e8fa7385ad28b7034624 | |
parent | 9e68a4279bd03f977fb8516be1b6c97009c5d07b (diff) | |
parent | 1a0f1a25a44005613e21591470aafecaec306202 (diff) | |
download | cmake-91c9a5227384b374c80f1e6453bb830e3de68a4a.tar.gz |
Merge topic 'tweak_unset_docs'
1a0f1a25a4 Help: Clarify the unset command
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2300
-rw-r--r-- | Help/command/unset.rst | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/Help/command/unset.rst b/Help/command/unset.rst index a1fc95cc61..c19dd318a8 100644 --- a/Help/command/unset.rst +++ b/Help/command/unset.rst @@ -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 |