ENH: Improve ctest_* command documentation

This corrects the terse documentation and adds detail to the full
documentation of some commands.  It also normalizes the layout of the
documentation string endings to make adding lines easier.
This commit is contained in:
Brad King 2009-02-20 15:50:57 -05:00
parent 17dc49c013
commit ab1b9b45ff
6 changed files with 36 additions and 19 deletions

View File

@ -55,7 +55,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Builds the repository."; return "Build the project.";
} }
virtual bool InitialPass(std::vector<std::string> const& args, virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status); cmExecutionStatus &status);
@ -65,9 +65,15 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" ctest_build([BUILD build_dir] [RETURN_VALUE res] " " ctest_build([BUILD build_dir] [RETURN_VALUE res]\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. "
"The RETURN_VALUE option specifies a variable in which to store the "
"return value of the native build tool. "
"The NUMBER_ERRORS and NUMBER_WARNINGS options specify variables in "
"which to store the number of build errors and warnings detected."
;
} }
cmTypeMacro(cmCTestBuildCommand, cmCTestHandlerCommand); cmTypeMacro(cmCTestBuildCommand, cmCTestHandlerCommand);

View File

@ -50,7 +50,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Configures the repository."; return "Configure the project build tree.";
} }
/** /**
@ -59,12 +59,17 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" ctest_configure(BUILD build_dir OPTIONS options RETURN_VALUE res)\n" " ctest_configure([BUILD build_dir] [SOURCE source_dir]\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. The OPTIONS arguments are passed as command line " "Configure.xml. "
"arguments to the configure command. " "If no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. "
"The RETURN_VALUE argument is a variable that will hold " "If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. "
"the return value."; "The OPTIONS argument specifies command line arguments to pass to "
"the configuration tool. "
"The RETURN_VALUE option specifies a variable in which to store the "
"return value of the native build tool."
;
} }
cmTypeMacro(cmCTestConfigureCommand, cmCTestHandlerCommand); cmTypeMacro(cmCTestConfigureCommand, cmCTestHandlerCommand);

View File

@ -51,7 +51,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Tests the repository."; return "Collect coverage tool results.";
} }
/** /**
@ -63,7 +63,8 @@ public:
" ctest_coverage([BUILD build_dir] [RETURN_VALUE res])\n" " ctest_coverage([BUILD build_dir] [RETURN_VALUE res])\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."
;
} }
cmTypeMacro(cmCTestCoverageCommand, cmCTestHandlerCommand); cmTypeMacro(cmCTestCoverageCommand, cmCTestHandlerCommand);

View File

@ -53,7 +53,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Tests the repository."; return "Run tests with a dynamic analysis tool.";
} }
/** /**
@ -65,7 +65,8 @@ public:
" ctest_memcheck([BUILD build_dir] [RETURN_VALUE res])\n" " ctest_memcheck([BUILD build_dir] [RETURN_VALUE res])\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."
;
} }
cmTypeMacro(cmCTestMemCheckCommand, cmCTestTestCommand); cmTypeMacro(cmCTestMemCheckCommand, cmCTestTestCommand);

View File

@ -51,7 +51,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Tests the repository."; return "Run tests in the project build tree.";
} }
/** /**
@ -73,7 +73,8 @@ public:
"expression for tests to run INCLUDE, or a regular expression for tests " "expression for tests to run INCLUDE, or a regular expression for tests "
"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."
;
} }
cmTypeMacro(cmCTestTestCommand, cmCTestHandlerCommand); cmTypeMacro(cmCTestTestCommand, cmCTestHandlerCommand);

View File

@ -51,7 +51,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Updates the repository."; return "Update the work tree from version control.";
} }
/** /**
@ -62,8 +62,11 @@ public:
return return
" ctest_update([SOURCE source] [RETURN_VALUE res])\n" " ctest_update([SOURCE source] [RETURN_VALUE res])\n"
"Updates the given source directory and stores results in Update.xml. " "Updates the given source directory and stores results in Update.xml. "
"The second argument is a variable that will hold the number of files " "If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. "
"modified. If there is a problem, the variable will be -1."; "The RETURN_VALUE option specifies a variable in which to store the "
"result, which is -1 on error, non-negative for success, and positive "
"if there are local modifications in the work tree."
;
} }
cmTypeMacro(cmCTestUpdateCommand, cmCTestHandlerCommand); cmTypeMacro(cmCTestUpdateCommand, cmCTestHandlerCommand);