summaryrefslogtreecommitdiff
path: root/Help/command/write_file.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Help/command/write_file.rst')
-rw-r--r--Help/command/write_file.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/Help/command/write_file.rst b/Help/command/write_file.rst
new file mode 100644
index 000000000..40e755763
--- /dev/null
+++ b/Help/command/write_file.rst
@@ -0,0 +1,20 @@
+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.