diff options
author | Michael Scott <michael.scott250@gmail.com> | 2015-06-04 21:51:22 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2015-06-08 20:28:31 (GMT) |
commit | c3f40f4fd98388a2fd31c707e7225d33a7fc76f6 (patch) | |
tree | 4b76a32ab9bf416fe1b5d5bd60bc68e1f267b3a7 /Help/command/execute_process.rst | |
parent | d17aa60659a1a69f9101c61a149eca5842291226 (diff) | |
download | CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.zip CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.gz CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.bz2 |
Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more
places.
Diffstat (limited to 'Help/command/execute_process.rst')
-rw-r--r-- | Help/command/execute_process.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst index c38ec1a..ca44b53 100644 --- a/Help/command/execute_process.rst +++ b/Help/command/execute_process.rst @@ -26,7 +26,7 @@ A single standard error pipe is used for all processes. Options: -COMMAND +``COMMAND`` A child process command line. CMake executes the child process using operating system APIs directly. @@ -36,31 +36,31 @@ COMMAND (Use the ``INPUT_*``, ``OUTPUT_*``, and ``ERROR_*`` options to redirect stdin, stdout, and stderr.) -WORKING_DIRECTORY +``WORKING_DIRECTORY`` The named directory will be set as the current working directory of the child processes. -TIMEOUT +``TIMEOUT`` The child processes will be terminated if they do not finish in the specified number of seconds (fractions are allowed). -RESULT_VARIABLE +``RESULT_VARIABLE`` The variable will be set to contain the result of running the processes. This will be an integer return code from the last child or a string describing an error condition. -OUTPUT_VARIABLE, ERROR_VARIABLE +``OUTPUT_VARIABLE``, ``ERROR_VARIABLE`` The variable named will be set with the contents of the standard output and standard error pipes, respectively. If the same variable is named for both pipes their output will be merged in the order produced. -INPUT_FILE, OUTPUT_FILE, ERROR_FILE +``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. -OUTPUT_QUIET, ERROR_QUIET +``OUTPUT_QUIET``, ``ERROR_QUIET`` The standard output or standard error results will be quietly ignored. If more than one ``OUTPUT_*`` or ``ERROR_*`` option is given for the |