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/exec_program.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/exec_program.rst')
-rw-r--r-- | Help/command/exec_program.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Help/command/exec_program.rst b/Help/command/exec_program.rst index aaa0dac..6dfdad3 100644 --- a/Help/command/exec_program.rst +++ b/Help/command/exec_program.rst @@ -1,7 +1,7 @@ exec_program ------------ -Deprecated. Use the execute_process() command instead. +Deprecated. Use the :command:`execute_process` command instead. Run an executable program during the processing of the CMakeList.txt file. @@ -15,10 +15,10 @@ file. The executable is run in the optionally specified directory. The executable can include arguments if it is double quoted, but it is -better to use the optional ARGS argument to specify arguments to the +better to use the optional ``ARGS`` argument to specify arguments to the program. This is because cmake will then be able to escape spaces in -the executable path. An optional argument OUTPUT_VARIABLE specifies a +the executable path. An optional argument ``OUTPUT_VARIABLE`` specifies a variable in which to store the output. To capture the return value of -the execution, provide a RETURN_VALUE. If OUTPUT_VARIABLE is +the execution, provide a ``RETURN_VALUE``. If ``OUTPUT_VARIABLE`` is specified, then no output will go to the stdout/stderr of the console running cmake. |