summaryrefslogtreecommitdiffstats
path: root/Help/command/write_file.rst
diff options
context:
space:
mode:
authorMichael Scott <michael.scott250@gmail.com>2015-06-04 21:51:22 (GMT)
committerBrad King <brad.king@kitware.com>2015-06-08 20:28:31 (GMT)
commitc3f40f4fd98388a2fd31c707e7225d33a7fc76f6 (patch)
tree4b76a32ab9bf416fe1b5d5bd60bc68e1f267b3a7 /Help/command/write_file.rst
parentd17aa60659a1a69f9101c61a149eca5842291226 (diff)
downloadCMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.zip
CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.gz
CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.bz2
Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more places.
Diffstat (limited to 'Help/command/write_file.rst')
-rw-r--r--Help/command/write_file.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/Help/command/write_file.rst b/Help/command/write_file.rst
index 015514b..40e7557 100644
--- a/Help/command/write_file.rst
+++ b/Help/command/write_file.rst
@@ -1,20 +1,20 @@
write_file
----------
-Deprecated. Use the file(WRITE ) command instead.
+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
+messages to write. If the argument ``APPEND`` is specified, then the
message will be appended.
-NOTE 1: file(WRITE ... and file(APPEND ... do exactly the same as
-this one but add some more functionality.
+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
+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 configure_file if you want to generate input
-files to CMake.
+to an infinite loop. Use :command:`configure_file` if you want to
+generate input files to CMake.