CMake/Help/command/write_file.rst
Michael Scott c3f40f4fd9 Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more
places.
2015-06-08 16:28:31 -04:00

21 lines
675 B
ReStructuredText

write_file
----------
Deprecated. Use the :command:`file(WRITE)` command instead.
::
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.