ab1b9b45ff
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.
80 lines
2.2 KiB
C++
80 lines
2.2 KiB
C++
/*=========================================================================
|
|
|
|
Program: CMake - Cross-Platform Makefile Generator
|
|
Module: $RCSfile$
|
|
Language: C++
|
|
Date: $Date$
|
|
Version: $Revision$
|
|
|
|
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
|
|
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notices for more information.
|
|
|
|
=========================================================================*/
|
|
#ifndef cmCTestUpdateCommand_h
|
|
#define cmCTestUpdateCommand_h
|
|
|
|
#include "cmCTestHandlerCommand.h"
|
|
|
|
/** \class cmCTestUpdate
|
|
* \brief Run a ctest script
|
|
*
|
|
* cmCTestUpdateCommand defineds the command to updates the repository.
|
|
*/
|
|
class cmCTestUpdateCommand : public cmCTestHandlerCommand
|
|
{
|
|
public:
|
|
|
|
cmCTestUpdateCommand() {}
|
|
|
|
/**
|
|
* This is a virtual constructor for the command.
|
|
*/
|
|
virtual cmCommand* Clone()
|
|
{
|
|
cmCTestUpdateCommand* ni = new cmCTestUpdateCommand;
|
|
ni->CTest = this->CTest;
|
|
ni->CTestScriptHandler = this->CTestScriptHandler;
|
|
return ni;
|
|
}
|
|
|
|
/**
|
|
* The name of the command as specified in CMakeList.txt.
|
|
*/
|
|
virtual const char* GetName() { return "ctest_update";}
|
|
|
|
/**
|
|
* Succinct documentation.
|
|
*/
|
|
virtual const char* GetTerseDocumentation()
|
|
{
|
|
return "Update the work tree from version control.";
|
|
}
|
|
|
|
/**
|
|
* More documentation.
|
|
*/
|
|
virtual const char* GetFullDocumentation()
|
|
{
|
|
return
|
|
" 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."
|
|
;
|
|
}
|
|
|
|
cmTypeMacro(cmCTestUpdateCommand, cmCTestHandlerCommand);
|
|
|
|
protected:
|
|
cmCTestGenericHandler* InitializeHandler();
|
|
};
|
|
|
|
|
|
#endif
|