echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Help: configure_file: add $CACHE{VAR} and $ENV{VAR} to description

Browse Source 
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
This commit is contained in:
Torsten Rasmussen 2023-05-22 10:54:26 +02:00 committed by Brad King
parent fc29c5f1bf
commit b2b97d015e
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Help/command/configure_file.rst
View File

@ -12,10 +12,10 @@ Copy a file to another location and modify its contents.
[NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]) [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])
Copies an ``<input>`` file to an ``<output>`` file and substitutes Copies an ``<input>`` file to an ``<output>`` file and substitutes
variable values referenced as ``@VAR@`` or ``${VAR}`` in the input variable values referenced as ``@VAR@``, ``${VAR}``, ``$CACHE{VAR}`` or
file content. Each variable reference will be replaced with the ``$ENV{VAR}`` in the input file content. Each variable reference will be
current value of the variable, or the empty string if the variable replaced with the current value of the variable, or the empty string if
is not defined. Furthermore, input lines of the form the variable is not defined. Furthermore, input lines of the form
.. code-block:: c .. code-block:: c