Skip to content
Snippets Groups Projects
Commit 4168bc18 authored by Brad King's avatar Brad King
Browse files

Help: Improve execute_process ENCODING option documentation

Spell out the options in a definition list and document each one.
parent 30abf145
No related branches found
No related tags found
No related merge requests found
......@@ -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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment