mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-07 06:09:52 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Improve execute_process ENCODING option documentation

Browse Source 
Spell out the options in a definition list and document each one.
This commit is contained in:
Brad King
2017-02-13 13:43:01 -05:00
parent 30abf145fd
commit 4168bc184e
1 changed files with 15 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Help/command/execute_process.rst
View File

@@ -70,10 +70,21 @@ Options:
``ENCODING <name>`` ``ENCODING <name>``
On Windows, the encoding that is used to decode output from the process. On Windows, the encoding that is used to decode output from the process.
Ignored on other platforms. Ignored on other platforms.
Valid encoding names are: ``AUTO`` (the default), ``NONE``, ``UTF8``, Valid encoding names are:
``ANSI`` and ``OEM``.
``AUTO`` encoding means current active console's codepage will be used ``NONE``
or if that isn't available then ``ANSI`` codepage will be used. 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 If more than one ``OUTPUT_*`` or ``ERROR_*`` option is given for the
same pipe the precedence is not specified. same pipe the precedence is not specified.