kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ENH: Document APPEND option in ctest_* commands 

This adds documentation of the APPEND option to the configure, build,
test, memcheck, and coverage commands.  The docs leave specific
semantics for the dashboard server to define.
This commit is contained in:
Brad King 2009-02-20 15:51:03 -05:00
parent ab1b9b45ff
commit 31e652059a
6 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Source/CTest/cmCTestBuildCommand.h
View File

@ -65,7 +65,7 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" ctest_build([BUILD build_dir] [RETURN_VALUE res]\n" " ctest_build([BUILD build_dir] [RETURN_VALUE res] [APPEND]\n"
" [NUMBER_ERRORS val] [NUMBER_WARNINGS val])\n" " [NUMBER_ERRORS val] [NUMBER_WARNINGS val])\n"
"Builds the given build directory and stores results in Build.xml. " "Builds the given build directory and stores results in Build.xml. "
"If no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. " "If no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. "
@ -73,7 +73,8 @@ public:
"return value of the native build tool. " "return value of the native build tool. "
"The NUMBER_ERRORS and NUMBER_WARNINGS options specify variables in " "The NUMBER_ERRORS and NUMBER_WARNINGS options specify variables in "
"which to store the number of build errors and warnings detected." "which to store the number of build errors and warnings detected."
; "\n"
CTEST_COMMAND_APPEND_OPTION_DOCS;
} }
cmTypeMacro(cmCTestBuildCommand, cmCTestHandlerCommand); cmTypeMacro(cmCTestBuildCommand, cmCTestHandlerCommand);

5
Source/CTest/cmCTestConfigureCommand.h
View File

@ -59,7 +59,7 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" ctest_configure([BUILD build_dir] [SOURCE source_dir]\n" " ctest_configure([BUILD build_dir] [SOURCE source_dir] [APPEND]\n"
" [OPTIONS options] [RETURN_VALUE res])\n" " [OPTIONS options] [RETURN_VALUE res])\n"
"Configures the given build directory and stores results in " "Configures the given build directory and stores results in "
"Configure.xml. " "Configure.xml. "
@ -69,7 +69,8 @@ public:
"the configuration tool. " "the configuration tool. "
"The RETURN_VALUE option specifies a variable in which to store the " "The RETURN_VALUE option specifies a variable in which to store the "
"return value of the native build tool." "return value of the native build tool."
; "\n"
CTEST_COMMAND_APPEND_OPTION_DOCS;
} }
cmTypeMacro(cmCTestConfigureCommand, cmCTestHandlerCommand); cmTypeMacro(cmCTestConfigureCommand, cmCTestHandlerCommand);

5
Source/CTest/cmCTestCoverageCommand.h
View File

@ -60,11 +60,12 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" ctest_coverage([BUILD build_dir] [RETURN_VALUE res])\n" " ctest_coverage([BUILD build_dir] [RETURN_VALUE res] [APPEND])\n"
"Perform the coverage of the given build directory and stores results " "Perform the coverage of the given build directory and stores results "
"in Coverage.xml. The second argument is a variable that will hold " "in Coverage.xml. The second argument is a variable that will hold "
"value." "value."
; "\n"
CTEST_COMMAND_APPEND_OPTION_DOCS;
} }
cmTypeMacro(cmCTestCoverageCommand, cmCTestHandlerCommand); cmTypeMacro(cmCTestCoverageCommand, cmCTestHandlerCommand);

5
Source/CTest/cmCTestHandlerCommand.h
View File

@ -74,4 +74,9 @@ protected:
size_t Last; size_t Last;
}; };
#define CTEST_COMMAND_APPEND_OPTION_DOCS \
"The APPEND option marks results for append to those previously " \
"submitted to a dashboard server since the last ctest_start. " \
"Append semantics are defined by the dashboard server in use."
#endif #endif

5
Source/CTest/cmCTestMemCheckCommand.h
View File

@ -62,11 +62,12 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" ctest_memcheck([BUILD build_dir] [RETURN_VALUE res])\n" " ctest_memcheck([BUILD build_dir] [RETURN_VALUE res] [APPEND])\n"
"Performs a memory checking of tests in the given build directory and " "Performs a memory checking of tests in the given build directory and "
"stores results in MemCheck.xml. The second argument is a variable " "stores results in MemCheck.xml. The second argument is a variable "
"that will hold value." "that will hold value."
; "\n"
CTEST_COMMAND_APPEND_OPTION_DOCS;
} }
cmTypeMacro(cmCTestMemCheckCommand, cmCTestTestCommand); cmTypeMacro(cmCTestMemCheckCommand, cmCTestTestCommand);

5
Source/CTest/cmCTestTestCommand.h
View File

@ -60,7 +60,7 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" ctest_test([BUILD build_dir]\n" " ctest_test([BUILD build_dir] [APPEND]\n"
" [START start number] [END end number]\n" " [START start number] [END end number]\n"
" [STRIDE stride number] [EXCLUDE exclude regex ]\n" " [STRIDE stride number] [EXCLUDE exclude regex ]\n"
" [INCLUDE include regex] [RETURN_VALUE res] \n" " [INCLUDE include regex] [RETURN_VALUE res] \n"
@ -74,7 +74,8 @@ public:
"to not run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular " "to not run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular "
"expression for test to be included or excluded by the test " "expression for test to be included or excluded by the test "
"property LABEL." "property LABEL."
; "\n"
CTEST_COMMAND_APPEND_OPTION_DOCS;
} }
cmTypeMacro(cmCTestTestCommand, cmCTestHandlerCommand); cmTypeMacro(cmCTestTestCommand, cmCTestHandlerCommand);