diff options
author | Brad King <brad.king@kitware.com> | 2017-02-13 18:43:01 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2017-02-13 18:53:17 (GMT) |
commit | 4168bc184e3e15ee76485e49d3bc5852b90f27de (patch) | |
tree | f87a5f969c7a819eacfb4cf32abd92811f36cc66 /Help | |
parent | 30abf145fd48f50c26ee7553fd2512e59be97f25 (diff) | |
download | CMake-4168bc184e3e15ee76485e49d3bc5852b90f27de.zip CMake-4168bc184e3e15ee76485e49d3bc5852b90f27de.tar.gz CMake-4168bc184e3e15ee76485e49d3bc5852b90f27de.tar.bz2 |
Help: Improve execute_process ENCODING option documentation
Spell out the options in a definition list and document each one.
Diffstat (limited to 'Help')
-rw-r--r-- | Help/command/execute_process.rst | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst index 71233d9..5a77735 100644 --- a/Help/command/execute_process.rst +++ b/Help/command/execute_process.rst @@ -70,10 +70,21 @@ Options: ``ENCODING <name>`` On Windows, the encoding that is used to decode output from the process. Ignored on other platforms. - Valid encoding names are: ``AUTO`` (the default), ``NONE``, ``UTF8``, - ``ANSI`` and ``OEM``. - ``AUTO`` encoding means current active console's codepage will be used - or if that isn't available then ``ANSI`` codepage will be used. + Valid encoding names are: + + ``NONE`` + Perform no decoding. This assumes that the process output is encoded + in the same way as CMake's internal encoding (UTF-8). + ``AUTO`` + Use the current active console's codepage or if that isn't + available then use ANSI. + This is the default. + ``ANSI`` + Use the ANSI codepage. + ``OEM`` + Use the original equipment manufacturer (OEM) code page. + ``UTF8`` + Use the UTF-8 codepage. If more than one ``OUTPUT_*`` or ``ERROR_*`` option is given for the same pipe the precedence is not specified. |