[Cmake-commits] [cmake-commits] king committed cmCTestBuildCommand.h 1.7 1.8 cmCTestConfigureCommand.h 1.7 1.8 cmCTestCoverageCommand.h 1.5 1.6 cmCTestMemCheckCommand.h 1.5 1.6 cmCTestTestCommand.h 1.9 1.10 cmCTestUpdateCommand.h 1.6 1.7
cmake-commits at cmake.org
cmake-commits at cmake.org
Fri Feb 20 15:50:59 EST 2009
Update of /cvsroot/CMake/CMake/Source/CTest
In directory public:/mounts/ram/cvs-serv6909/Source/CTest
Modified Files:
cmCTestBuildCommand.h cmCTestConfigureCommand.h
cmCTestCoverageCommand.h cmCTestMemCheckCommand.h
cmCTestTestCommand.h cmCTestUpdateCommand.h
Log Message:
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.
Index: cmCTestUpdateCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/CTest/cmCTestUpdateCommand.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -C 2 -d -r1.6 -r1.7
*** cmCTestUpdateCommand.h 12 May 2008 13:11:51 -0000 1.6
--- cmCTestUpdateCommand.h 20 Feb 2009 20:50:57 -0000 1.7
***************
*** 52,56 ****
virtual const char* GetTerseDocumentation()
{
! return "Updates the repository.";
}
--- 52,56 ----
virtual const char* GetTerseDocumentation()
{
! return "Update the work tree from version control.";
}
***************
*** 63,68 ****
" ctest_update([SOURCE source] [RETURN_VALUE res])\n"
"Updates the given source directory and stores results in Update.xml. "
! "The second argument is a variable that will hold the number of files "
! "modified. If there is a problem, the variable will be -1.";
}
--- 63,71 ----
" ctest_update([SOURCE source] [RETURN_VALUE res])\n"
"Updates the given source directory and stores results in Update.xml. "
! "If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. "
! "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."
! ;
}
Index: cmCTestConfigureCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/CTest/cmCTestConfigureCommand.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -C 2 -d -r1.7 -r1.8
*** cmCTestConfigureCommand.h 30 Dec 2008 14:13:02 -0000 1.7
--- cmCTestConfigureCommand.h 20 Feb 2009 20:50:57 -0000 1.8
***************
*** 51,55 ****
virtual const char* GetTerseDocumentation()
{
! return "Configures the repository.";
}
--- 51,55 ----
virtual const char* GetTerseDocumentation()
{
! return "Configure the project build tree.";
}
***************
*** 60,69 ****
{
return
! " ctest_configure(BUILD build_dir OPTIONS options RETURN_VALUE res)\n"
"Configures the given build directory and stores results in "
! "Configure.xml. The OPTIONS arguments are passed as command line "
! "arguments to the configure command. "
! "The RETURN_VALUE argument is a variable that will hold "
! "the return value.";
}
--- 60,74 ----
{
return
! " ctest_configure([BUILD build_dir] [SOURCE source_dir]\n"
! " [OPTIONS options] [RETURN_VALUE res])\n"
"Configures the given build directory and stores results in "
! "Configure.xml. "
! "If no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. "
! "If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. "
! "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."
! ;
}
Index: cmCTestCoverageCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/CTest/cmCTestCoverageCommand.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -C 2 -d -r1.5 -r1.6
*** cmCTestCoverageCommand.h 12 May 2008 13:11:51 -0000 1.5
--- cmCTestCoverageCommand.h 20 Feb 2009 20:50:57 -0000 1.6
***************
*** 52,56 ****
virtual const char* GetTerseDocumentation()
{
! return "Tests the repository.";
}
--- 52,56 ----
virtual const char* GetTerseDocumentation()
{
! return "Collect coverage tool results.";
}
***************
*** 64,68 ****
"Perform the coverage of the given build directory and stores results "
"in Coverage.xml. The second argument is a variable that will hold "
! "value.";
}
--- 64,69 ----
"Perform the coverage of the given build directory and stores results "
"in Coverage.xml. The second argument is a variable that will hold "
! "value."
! ;
}
Index: cmCTestBuildCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/CTest/cmCTestBuildCommand.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -C 2 -d -r1.7 -r1.8
*** cmCTestBuildCommand.h 14 Jan 2009 18:01:38 -0000 1.7
--- cmCTestBuildCommand.h 20 Feb 2009 20:50:57 -0000 1.8
***************
*** 56,60 ****
virtual const char* GetTerseDocumentation()
{
! return "Builds the repository.";
}
virtual bool InitialPass(std::vector<std::string> const& args,
--- 56,60 ----
virtual const char* GetTerseDocumentation()
{
! return "Build the project.";
}
virtual bool InitialPass(std::vector<std::string> const& args,
***************
*** 66,72 ****
{
return
! " ctest_build([BUILD build_dir] [RETURN_VALUE res] "
! " [NUMBER_ERRORS val] [NUMBER_WARNINGS val])\n"
! "Builds the given build directory and stores results in Build.xml.";
}
--- 66,78 ----
{
return
! " ctest_build([BUILD build_dir] [RETURN_VALUE res]\n"
! " [NUMBER_ERRORS val] [NUMBER_WARNINGS val])\n"
! "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."
! ;
}
Index: cmCTestTestCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/CTest/cmCTestTestCommand.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -C 2 -d -r1.9 -r1.10
*** cmCTestTestCommand.h 10 Feb 2009 19:24:23 -0000 1.9
--- cmCTestTestCommand.h 20 Feb 2009 20:50:57 -0000 1.10
***************
*** 52,56 ****
virtual const char* GetTerseDocumentation()
{
! return "Tests the repository.";
}
--- 52,56 ----
virtual const char* GetTerseDocumentation()
{
! return "Run tests in the project build tree.";
}
***************
*** 74,78 ****
"to not run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular "
"expression for test to be included or excluded by the test "
! "property LABEL.";
}
--- 74,79 ----
"to not run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular "
"expression for test to be included or excluded by the test "
! "property LABEL."
! ;
}
Index: cmCTestMemCheckCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/CTest/cmCTestMemCheckCommand.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -C 2 -d -r1.5 -r1.6
*** cmCTestMemCheckCommand.h 12 May 2008 13:11:51 -0000 1.5
--- cmCTestMemCheckCommand.h 20 Feb 2009 20:50:57 -0000 1.6
***************
*** 54,58 ****
virtual const char* GetTerseDocumentation()
{
! return "Tests the repository.";
}
--- 54,58 ----
virtual const char* GetTerseDocumentation()
{
! return "Run tests with a dynamic analysis tool.";
}
***************
*** 66,70 ****
"Performs a memory checking of tests in the given build directory and "
"stores results in MemCheck.xml. The second argument is a variable "
! "that will hold value.";
}
--- 66,71 ----
"Performs a memory checking of tests in the given build directory and "
"stores results in MemCheck.xml. The second argument is a variable "
! "that will hold value."
! ;
}
More information about the Cmake-commits
mailing list