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

ENH: More documentation for ctest_submit command 

This clarifies the terse documentation and lists valid values for PARTS.
This commit is contained in:
Brad King 2009-02-20 15:50:15 -05:00
parent f04fed206f
commit 17dc49c013
1 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Source/CTest/cmCTestSubmitCommand.h
View File

@ -57,7 +57,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Submits the repository."; return "Submit results to a dashboard server.";
} }
/** /**
@ -66,12 +66,23 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" ctest_submit([RETURN_VALUE res] [PARTS ...] [FILES ...])\n" " ctest_submit([PARTS ...] [FILES ...] [RETURN_VALUE res])\n"
"Submits the test results for the project. " "By default all available parts are submitted if no PARTS or FILES "
"By default all available parts are submitted. " "are specified. "
"The PARTS option lists a subset of parts to be submitted. " "The PARTS option lists a subset of parts to be submitted. "
"Valid part names are:\n"
" Start = nothing\n"
" Update = ctest_update results, in Update.xml\n"
" Configure = ctest_configure results, in Configure.xml\n"
" Build = ctest_build results, in Build.xml\n"
" Test = ctest_test results, in Test.xml\n"
" Coverage = ctest_coverage results, in Coverage.xml\n"
" MemCheck = ctest_memcheck results, in DynamicAnalysis.xml\n"
" Notes = Files listed by CTEST_NOTES_FILES, in Notes.xml\n"
" ExtraFiles = Files listed by CTEST_EXTRA_SUBMIT_FILES\n"
" Submit = nothing\n"
"The FILES option explicitly lists specific files to be submitted. " "The FILES option explicitly lists specific files to be submitted. "
"Each individual file must exist at the time of the call."; "Each individual file must exist at the time of the call.\n";
} }
cmTypeMacro(cmCTestSubmitCommand, cmCTestHandlerCommand); cmTypeMacro(cmCTestSubmitCommand, cmCTestHandlerCommand);