diff options
author | Joachim Wuttke (h) <j.wuttke@fz-juelich.de> | 2018-10-27 13:53:05 (GMT) |
---|---|---|
committer | Joachim Wuttke (h) <j.wuttke@fz-juelich.de> | 2018-11-08 19:27:49 (GMT) |
commit | e24ef9694275b9345bf08cf46ca1cf064b34813b (patch) | |
tree | 4fa78a1334cbd96bd808d0ee8b5461994be5a1b2 /Help/manual | |
parent | e4554149c476e9eb9fe00368b2ac1ac7ac9ffe5c (diff) | |
download | CMake-e24ef9694275b9345bf08cf46ca1cf064b34813b.zip CMake-e24ef9694275b9345bf08cf46ca1cf064b34813b.tar.gz CMake-e24ef9694275b9345bf08cf46ca1cf064b34813b.tar.bz2 |
Help: New section on Environment Variables in cmake-language.7
Diffstat (limited to 'Help/manual')
-rw-r--r-- | Help/manual/cmake-language.7.rst | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/Help/manual/cmake-language.7.rst b/Help/manual/cmake-language.7.rst index 0283232..ef5bb50 100644 --- a/Help/manual/cmake-language.7.rst +++ b/Help/manual/cmake-language.7.rst @@ -406,7 +406,7 @@ The `Variables`_ section documents the scope of variable names and how their values are set. An *environment variable reference* has the form ``$ENV{VAR}``. -See :variable:`ENV` for more information. +See the `Environment Variables`_ section for more information. A *cache variable reference* has the form ``$CACHE{VAR}``. See :variable:`CACHE` for more information. @@ -563,6 +563,33 @@ by project code. .. _`CMake Language Lists`: +Environment Variables +===================== + +Environment Variables are like ordinary `Variables`_, with the +following differences: + +Scope + Environment variables have global scope in a CMake process. + They are never cached. + +References + `Variable References`_ have the form ``$ENV{<variable>}``. + +Initialization + Initial values of the CMake environment variables are those of + the calling process. + Values can be changed using the :command:`set` and :command:`unset` + commands. + These commands only affect the running CMake process, + not the system environment at large. + Changed values are not written back to the calling process, + and they are not seen by subsequent build or test processes. + +The :manual:`cmake-env-variables(7)` manual documents environment +variables that have special meaning to CMake. + + Lists ===== |