diff options
| author | Michael Scott <michael.scott250@gmail.com> | 2015-06-04 21:51:22 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-06-08 20:28:31 (GMT) |
| commit | c3f40f4fd98388a2fd31c707e7225d33a7fc76f6 (patch) | |
| tree | 4b76a32ab9bf416fe1b5d5bd60bc68e1f267b3a7 /Help/command/separate_arguments.rst | |
| parent | d17aa60659a1a69f9101c61a149eca5842291226 (diff) | |
| download | CMake-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/separate_arguments.rst')
| -rw-r--r-- | Help/command/separate_arguments.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Help/command/separate_arguments.rst b/Help/command/separate_arguments.rst index a876595..0e3e5a5 100644 --- a/Help/command/separate_arguments.rst +++ b/Help/command/separate_arguments.rst @@ -8,15 +8,15 @@ Parse space-separated arguments into a semicolon-separated list. separate_arguments(<var> <UNIX|WINDOWS>_COMMAND "<args>") Parses a unix- or windows-style command-line string "<args>" and -stores a semicolon-separated list of the arguments in <var>. The +stores a semicolon-separated list of the arguments in ``<var>``. The entire command line must be given in one "<args>" argument. -The UNIX_COMMAND mode separates arguments by unquoted whitespace. It +The ``UNIX_COMMAND`` mode separates arguments by unquoted whitespace. It recognizes both single-quote and double-quote pairs. A backslash escapes the next literal character (\" is "); there are no special escapes (\n is just n). -The WINDOWS_COMMAND mode parses a windows command-line using the same +The ``WINDOWS_COMMAND`` mode parses a windows command-line using the same syntax the runtime library uses to construct argv at startup. It separates arguments by whitespace that is not double-quoted. Backslashes are literal unless they precede double-quotes. See the @@ -26,6 +26,6 @@ MSDN article "Parsing C Command-Line Arguments" for details. separate_arguments(VARIABLE) -Convert the value of VARIABLE to a semi-colon separated list. All +Convert the value of ``VARIABLE`` to a semi-colon separated list. All spaces are replaced with ';'. This helps with generating command lines. |