mirror of
https://github.com/Kitware/CMake.git
synced 2026-02-21 22:50:26 -06:00
Drop builtin command documentation
Drop all GetTerseDocumentation and GetFullDocumentation methods from commands. The command documentation is now in Help/command/*.rst files.
This commit is contained in:
@@ -43,14 +43,6 @@ public:
|
||||
*/
|
||||
virtual const char* GetName() const { return "install_programs";}
|
||||
|
||||
/**
|
||||
* Succinct documentation.
|
||||
*/
|
||||
virtual const char* GetTerseDocumentation() const
|
||||
{
|
||||
return "Deprecated. Use the install(PROGRAMS ) command instead.";
|
||||
}
|
||||
|
||||
/**
|
||||
* This is called at the end after all the information
|
||||
* specified by the command is accumulated. Most commands do
|
||||
@@ -61,33 +53,6 @@ public:
|
||||
|
||||
virtual bool HasFinalPass() const { return true; }
|
||||
|
||||
/**
|
||||
* More documentation.
|
||||
*/
|
||||
virtual const char* GetFullDocumentation() const
|
||||
{
|
||||
return
|
||||
"This command has been superceded by the install command. It "
|
||||
"is provided for compatibility with older CMake code. "
|
||||
"The FILES form is directly replaced by the PROGRAMS form of the "
|
||||
"INSTALL command. The regexp form can be expressed more clearly "
|
||||
"using the GLOB form of the FILE command.\n"
|
||||
" install_programs(<dir> file1 file2 [file3 ...])\n"
|
||||
" install_programs(<dir> FILES file1 [file2 ...])\n"
|
||||
"Create rules to install the listed programs into the given directory. "
|
||||
"Use the FILES argument to guarantee that the file list version of "
|
||||
"the command will be used even when there is only one argument.\n"
|
||||
" install_programs(<dir> regexp)\n"
|
||||
"In the second form any program in the current source directory that "
|
||||
"matches the regular expression will be installed.\n"
|
||||
"This command is intended to install programs that are not built "
|
||||
"by cmake, such as shell scripts. See the TARGETS form of "
|
||||
"the INSTALL command to "
|
||||
"create installation rules for targets built by cmake.\n"
|
||||
"The directory <dir> is relative to the installation prefix, which "
|
||||
"is stored in the variable CMAKE_INSTALL_PREFIX.";
|
||||
}
|
||||
|
||||
/** This command is kept for compatibility with older CMake versions. */
|
||||
virtual bool IsDiscouraged() const
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user