summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorJames Touton <bekenn@gmail.com>2016-09-12 04:23:24 (GMT)
committerBrad King <brad.king@kitware.com>2016-09-12 15:53:21 (GMT)
commit4f349a8656e4652edacad787d38834255f13a0a5 (patch)
tree9f384efde7a4bc03c3fce61ebf0ac01bfe3cd5ee /Help/command
parent03bae46865f2abb3a74728986f523a30d79eb095 (diff)
downloadCMake-4f349a8656e4652edacad787d38834255f13a0a5.zip
CMake-4f349a8656e4652edacad787d38834255f13a0a5.tar.gz
CMake-4f349a8656e4652edacad787d38834255f13a0a5.tar.bz2
Help: Fix formatting in separate_arguments documentation
Make backslashes visible in the text. Rename VARIABLE to <var> in second signature for consistency with the first signature. Add link to referenced MSDN documentation.
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/separate_arguments.rst12
1 files changed, 7 insertions, 5 deletions
diff --git a/Help/command/separate_arguments.rst b/Help/command/separate_arguments.rst
index 0e3e5a5..1fd3cd1 100644
--- a/Help/command/separate_arguments.rst
+++ b/Help/command/separate_arguments.rst
@@ -13,19 +13,21 @@ entire command line must be given in one "<args>" argument.
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).
+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
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
-MSDN article "Parsing C Command-Line Arguments" for details.
+MSDN article `Parsing C Command-Line Arguments`_ for details.
+
+.. _`Parsing C Command-Line Arguments`: https://msdn.microsoft.com/library/a1y7w461.aspx
::
- separate_arguments(VARIABLE)
+ separate_arguments(<var>)
-Convert the value of ``VARIABLE`` to a semi-colon separated list. All
+Convert the value of ``<var>`` to a semi-colon separated list. All
spaces are replaced with ';'. This helps with generating command
lines.