summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorJoachim Wuttke (h) <j.wuttke@fz-juelich.de>2018-10-27 13:08:43 (GMT)
committerJoachim Wuttke (h) <j.wuttke@fz-juelich.de>2018-11-08 19:27:10 (GMT)
commit3de551cc22bf80f63ec9f05e3e934f42f79b8965 (patch)
treeadca666258fb26ceeb85296d1c45a33f65efffc7 /Help
parent17e98e00c449ebdceac980c0ce65c800030605db (diff)
downloadCMake-3de551cc22bf80f63ec9f05e3e934f42f79b8965.zip
CMake-3de551cc22bf80f63ec9f05e3e934f42f79b8965.tar.gz
CMake-3de551cc22bf80f63ec9f05e3e934f42f79b8965.tar.bz2
Help: Clarify effect of set(ENV{..} ..) and unset(ENV{..})
Explain that the commands affect 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.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/set.rst8
-rw-r--r--Help/command/unset.rst17
2 files changed, 20 insertions, 5 deletions
diff --git a/Help/command/set.rst b/Help/command/set.rst
index e37e693..dd5ea13 100644
--- a/Help/command/set.rst
+++ b/Help/command/set.rst
@@ -88,4 +88,10 @@ Set Environment Variable
set(ENV{<variable>} <value>...)
-Sets the current process environment ``<variable>`` to the given value.
+Sets an :manual:`Environment Variable <cmake-env-variables(7)>`
+to the given value.
+Subsequent calls of ``$ENV{<variable>}`` will return this new value.
+
+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.
diff --git a/Help/command/unset.rst b/Help/command/unset.rst
index 1a5e49f..7521052 100644
--- a/Help/command/unset.rst
+++ b/Help/command/unset.rst
@@ -3,6 +3,9 @@ unset
Unset a variable, cache variable, or environment variable.
+Unset Normal Variable or Cache Entry
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
.. code-block:: cmake
unset(<variable> [CACHE | PARENT_SCOPE])
@@ -22,11 +25,17 @@ 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.
-``<variable>`` can be an environment variable such as:
+Unset Environment Variable
+^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: cmake
- unset(ENV{LD_LIBRARY_PATH})
+ 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.
-in which case the variable will be removed from the current
-environment.
+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.