diff options
| author | Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no> | 2023-05-22 08:54:26 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2023-05-22 16:46:04 (GMT) |
| commit | b2b97d015ea2203147fce6d94a17a937f161d45f (patch) | |
| tree | 6b834e30bd302f757b28e879d63b24bb7e6292e9 /Help/command/configure_file.rst | |
| parent | fc29c5f1bf11d018278a08ae35e2672955f9871b (diff) | |
| download | CMake-b2b97d015ea2203147fce6d94a17a937f161d45f.zip CMake-b2b97d015ea2203147fce6d94a17a937f161d45f.tar.gz CMake-b2b97d015ea2203147fce6d94a17a937f161d45f.tar.bz2 | |
Help: configure_file: add $CACHE{VAR} and $ENV{VAR} to description
The configure_file(...) and string(CONFIGURE ...) functions also
substitutes variables of the form: $CACHE{VAR} and $ENV{VAR}.
Therefore add this information to the help documentation so that this
behavior is described to users
Diffstat (limited to 'Help/command/configure_file.rst')
| -rw-r--r-- | Help/command/configure_file.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Help/command/configure_file.rst b/Help/command/configure_file.rst index 6f4cedf..07dc2e1 100644 --- a/Help/command/configure_file.rst +++ b/Help/command/configure_file.rst @@ -12,10 +12,10 @@ Copy a file to another location and modify its contents. [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]) Copies an ``<input>`` file to an ``<output>`` file and substitutes -variable values referenced as ``@VAR@`` or ``${VAR}`` in the input -file content. Each variable reference will be replaced with the -current value of the variable, or the empty string if the variable -is not defined. Furthermore, input lines of the form +variable values referenced as ``@VAR@``, ``${VAR}``, ``$CACHE{VAR}`` or +``$ENV{VAR}`` in the input file content. Each variable reference will be +replaced with the current value of the variable, or the empty string if +the variable is not defined. Furthermore, input lines of the form .. code-block:: c |