summaryrefslogtreecommitdiffstats
path: root/Source/cmExecProgramCommand.h
diff options
context:
space:
mode:
authorAndy Cedilnik <andy.cedilnik@kitware.com>2002-08-08 19:29:19 (GMT)
committerAndy Cedilnik <andy.cedilnik@kitware.com>2002-08-08 19:29:19 (GMT)
commita898cfb17aabc7e54033208e760de8e237e2d2b1 (patch)
treea33c9a09b9a4c0785d1bd97e850b46d887747eda /Source/cmExecProgramCommand.h
parentf3a656e3915627414bd6ca6e88693f57ac206a34 (diff)
downloadCMake-a898cfb17aabc7e54033208e760de8e237e2d2b1.zip
CMake-a898cfb17aabc7e54033208e760de8e237e2d2b1.tar.gz
CMake-a898cfb17aabc7e54033208e760de8e237e2d2b1.tar.bz2
Add return value support and add documentation
Diffstat (limited to 'Source/cmExecProgramCommand.h')
-rw-r--r--Source/cmExecProgramCommand.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/Source/cmExecProgramCommand.h b/Source/cmExecProgramCommand.h
index 39af8b2..846f2e7 100644
--- a/Source/cmExecProgramCommand.h
+++ b/Source/cmExecProgramCommand.h
@@ -64,11 +64,13 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "EXEC_PROGRAM(Executable [Directory to run in] [ARGS arguments to executable] [OUTPUT_VARIABLE var])"
+ "EXEC_PROGRAM(Executable [Directory to run in] [ARGS arguments to executable] [OUTPUT_VARIABLE var] [RETURN_VALUE var])"
"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 program. This is because "
- "cmake will then be able to escape spaces in the Executable path.";
+ "cmake will then be able to escape spaces in the Executable path. An optiona "
+ "argument OUPUT_VARIABLE specifies a variable to which the output will be set. "
+ "To capture the return value of the execution, use RETURN_VALUE variable.";
}
cmTypeMacro(cmExecProgramCommand, cmCommand);