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.
This commit is contained in:
James Touton 2016-09-11 21:23:24 -07:00 committed by Brad King
parent 03bae46865
commit 4f349a8656
1 changed files with 7 additions and 5 deletions

View File

@ -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.