diff options
| author | Brad King <brad.king@kitware.com> | 2015-06-09 13:18:54 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2015-06-09 13:18:54 (GMT) |
| commit | 1adcec3983c4c017f4e0d79e5bb7d68742ec58ea (patch) | |
| tree | 65c5a8f6ec8994a0a2e5bbd245d182c95039bdea /Help/command/write_file.rst | |
| parent | 7f14943e5c7d508e937d45cb2608b07dd7c1e2b0 (diff) | |
| parent | c3f40f4fd98388a2fd31c707e7225d33a7fc76f6 (diff) | |
| download | CMake-1adcec3983c4c017f4e0d79e5bb7d68742ec58ea.zip CMake-1adcec3983c4c017f4e0d79e5bb7d68742ec58ea.tar.gz CMake-1adcec3983c4c017f4e0d79e5bb7d68742ec58ea.tar.bz2 | |
Merge topic 'doc-formatting'
c3f40f4f Help: Improve formatting of command documentation
Diffstat (limited to 'Help/command/write_file.rst')
| -rw-r--r-- | Help/command/write_file.rst | 14 |
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. |