diff options
| author | Taylor Holberton <taylorcholberton@gmail.com> | 2019-02-01 00:26:14 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2019-02-01 11:10:34 (GMT) |
| commit | cb01b8c8ba1754b40e74d89d2c6dfef5dc8c44d3 (patch) | |
| tree | 0c56204b6befc2f9ce85c397d7410bc5f5ccb994 /Help | |
| parent | d526327079e23748dd2a87acd4d9b4b1174725bf (diff) | |
| download | CMake-cb01b8c8ba1754b40e74d89d2c6dfef5dc8c44d3.zip CMake-cb01b8c8ba1754b40e74d89d2c6dfef5dc8c44d3.tar.gz CMake-cb01b8c8ba1754b40e74d89d2c6dfef5dc8c44d3.tar.bz2 | |
set: warn of extra arguments after ENV value.
Fixes: #18842
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/set.rst | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/Help/command/set.rst b/Help/command/set.rst index dd5ea13..c0e02e2 100644 --- a/Help/command/set.rst +++ b/Help/command/set.rst @@ -86,7 +86,7 @@ Set Environment Variable .. code-block:: cmake - set(ENV{<variable>} <value>...) + set(ENV{<variable>} [<value>]) Sets an :manual:`Environment Variable <cmake-env-variables(7)>` to the given value. @@ -95,3 +95,10 @@ 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. + +If no argument is given after ``ENV{<variable>}`` or if ``<value>`` is +an empty string, then this command will clear any existing value of the +environment variable. + +Arguments after ``<value>`` are ignored. If extra arguments are found, +then an author warning is issued. |