CMake/Help/command/write_file.rst
Alex Turbov 8c6274326d
Help: Use CMake highlighting for command synopsis
Most of CMake commands use it. Fix a few of them to do the same.
2022-11-09 23:52:30 +04:00

23 lines
705 B
ReStructuredText

write_file
----------
.. deprecated:: 3.0
Use the :command:`file(WRITE)` command instead.
.. code-block:: cmake
write_file(filename "message to write"... [APPEND])
The first argument is the file name, the rest of the arguments are
messages to write. If the argument ``APPEND`` is specified, then the
message will be appended.
NOTE 1: :command:`file(WRITE)` and :command:`file(APPEND)` do exactly
the same as this one but add some more functionality.
NOTE 2: When using ``write_file`` the produced file cannot be used as an
input to CMake (CONFIGURE_FILE, source file ...) because it will lead
to an infinite loop. Use :command:`configure_file` if you want to
generate input files to CMake.