diff options
author | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-07 20:30:30 (GMT) |
---|---|---|
committer | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-09 15:51:57 (GMT) |
commit | c705279bae45c85b689febd66d5437d9ec05c9b9 (patch) | |
tree | f64bca14f17a902a96d67a30357df3d1e6c745eb /Help/command/execute_process.rst | |
parent | 63a1917d098922b59bbba8fdeb42519363d5ba0d (diff) | |
download | CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.zip CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.tar.gz CMake-c705279bae45c85b689febd66d5437d9ec05c9b9.tar.bz2 |
Help: Add `.. versionadded` directives to commands documentation
This change ony concerns directives that appear in the document body.
The guidelines for inserting version directives:
* Baseline version is CMake 3.0, i.e. directives start at 3.1.
* Always use `.. versionadded::` directive, avoid ad-hoc version
references. Exception: policy pages.
* For new command signatures, put `versionadded` on a separate line
after the signature.
* For a group of new signatures in a new document section,
a single version note at the beginning of the section is sufficient.
* For new options, put `versionadded` on a separate line before
option description.
* If all the option descriptions in the list are short one-liners,
it's fine to put `versionadded` on the same line as the description.
* If multiple option descriptions in close proximity would have
the same ..versionadded directive, consider adding a single
directive after the list, mentioning all added options.
* For compact value lists and sub-option lists, put a single
`versionadded` directive after the list mentioning all additions.
* When a change is described in a single paragraph, put
`versionadded` into that paragraph.
* When only part of the paragraph has changed, separate the changed
part if it doesn't break the flow. Otherwise, write a follow-up
clarification paragraph and apply version directive to that.
* When multiple version directives are close by, order earlier
additions before later additions.
* Indent related lists and code blocks to include them in the scope
of `versionadded` directive.
Issue: #19715
Diffstat (limited to 'Help/command/execute_process.rst')
-rw-r--r-- | Help/command/execute_process.rst | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst index 268c307..82fcd46 100644 --- a/Help/command/execute_process.rst +++ b/Help/command/execute_process.rst @@ -62,6 +62,8 @@ Options: describing an error condition. ``RESULTS_VARIABLE <variable>`` + .. versionadded:: 3.10 + The variable will be set to contain the result of all processes as a :ref:`semicolon-separated list <CMake Language Lists>`, in order of the given ``COMMAND`` arguments. Each entry will be an integer return code @@ -75,19 +77,26 @@ Options: ``INPUT_FILE, OUTPUT_FILE``, ``ERROR_FILE`` The file named will be attached to the standard input of the first process, standard output of the last process, or standard error of - all processes, respectively. If the same file is named for both - output and error then it will be used for both. + all processes, respectively. + + .. versionadded:: 3.3 + If the same file is named for both output and error then it will be used + for both. ``OUTPUT_QUIET``, ``ERROR_QUIET`` The standard output or standard error results will be quietly ignored. ``COMMAND_ECHO <where>`` + .. versionadded:: 3.15 + The command being run will be echo'ed to ``<where>`` with ``<where>`` being set to one of ``STDERR``, ``STDOUT`` or ``NONE``. See the :variable:`CMAKE_EXECUTE_PROCESS_COMMAND_ECHO` variable for a way to control the default behavior when this option is not present. ``ENCODING <name>`` + .. versionadded:: 3.8 + On Windows, the encoding that is used to decode output from the process. Ignored on other platforms. Valid encoding names are: @@ -104,11 +113,15 @@ Options: ``OEM`` Use the original equipment manufacturer (OEM) code page. ``UTF8`` or ``UTF-8`` - Use the UTF-8 codepage. Prior to CMake 3.11.0, only ``UTF8`` was accepted - for this encoding. In CMake 3.11.0, ``UTF-8`` was added for consistency with - the `UTF-8 RFC <https://www.ietf.org/rfc/rfc3629>`_ naming convention. + Use the UTF-8 codepage. + + .. versionadded:: 3.11 + Accept ``UTF-8`` spelling for consistency with the + `UTF-8 RFC <https://www.ietf.org/rfc/rfc3629>`_ naming convention. ``ECHO_OUTPUT_VARIABLE``, ``ECHO_ERROR_VARIABLE`` + .. versionadded:: 3.18 + The standard output or standard error will not be exclusively redirected to the configured variables. @@ -118,6 +131,8 @@ Options: This is analogous to the ``tee`` Unix command. ``COMMAND_ERROR_IS_FATAL <ANY|LAST>`` + .. versionadded:: 3.19 + The option following ``COMMAND_ERROR_IS_FATAL`` determines the behavior when an error is encountered: |