summaryrefslogtreecommitdiff
path: root/Source/cmFindBase.cxx
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-09-17 13:23:40 -0400
committerBrad King <brad.king@kitware.com>2013-10-16 09:22:36 -0400
commite33d8d2d7799271e94b4f1215c77d6a685f82b88 (patch)
tree03726a7dacd9c06731de417d3f8c82f7bbb5e8f1 /Source/cmFindBase.cxx
parent399e9c46d88c12507f1a762e69225c5ab9f4ac08 (diff)
downloadcmake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.tar.gz
Drop builtin command documentation
Drop all GetTerseDocumentation and GetFullDocumentation methods from commands. The command documentation is now in Help/command/*.rst files.
Diffstat (limited to 'Source/cmFindBase.cxx')
-rw-r--r--Source/cmFindBase.cxx100
1 files changed, 0 insertions, 100 deletions
diff --git a/Source/cmFindBase.cxx b/Source/cmFindBase.cxx
index 7ce0032165..c1e7b1e6d8 100644
--- a/Source/cmFindBase.cxx
+++ b/Source/cmFindBase.cxx
@@ -20,106 +20,6 @@ cmFindBase::cmFindBase()
}
//----------------------------------------------------------------------------
-void cmFindBase::GenerateDocumentation()
-{
- this->cmFindCommon::GenerateDocumentation();
- cmSystemTools::ReplaceString(this->GenericDocumentationPathsOrder,
- "FIND_ARGS_XXX", "<VAR> NAMES name");
- this->GenericDocumentation =
- " FIND_XXX(<VAR> name1 [path1 path2 ...])\n"
- "This is the short-hand signature for the command that "
- "is sufficient in many cases. It is the same "
- "as FIND_XXX(<VAR> name1 [PATHS path1 path2 ...])\n"
- " FIND_XXX(\n"
- " <VAR>\n"
- " name | NAMES name1 [name2 ...]\n"
- " [HINTS path1 [path2 ... ENV var]]\n"
- " [PATHS path1 [path2 ... ENV var]]\n"
- " [PATH_SUFFIXES suffix1 [suffix2 ...]]\n"
- " [DOC \"cache documentation string\"]\n"
- " [NO_DEFAULT_PATH]\n"
- " [NO_CMAKE_ENVIRONMENT_PATH]\n"
- " [NO_CMAKE_PATH]\n"
- " [NO_SYSTEM_ENVIRONMENT_PATH]\n"
- " [NO_CMAKE_SYSTEM_PATH]\n"
- " [CMAKE_FIND_ROOT_PATH_BOTH |\n"
- " ONLY_CMAKE_FIND_ROOT_PATH |\n"
- " NO_CMAKE_FIND_ROOT_PATH]\n"
- " )\n"
- ""
- "This command is used to find a SEARCH_XXX_DESC. "
- "A cache entry named by <VAR> is created to store the result "
- "of this command. "
- "If the SEARCH_XXX is found the result is stored in the variable "
- "and the search will not be repeated unless the variable is cleared. "
- "If nothing is found, the result will be "
- "<VAR>-NOTFOUND, and the search will be attempted again the "
- "next time FIND_XXX is invoked with the same variable. "
- "The name of the SEARCH_XXX that "
- "is searched for is specified by the names listed "
- "after the NAMES argument. Additional search locations "
- "can be specified after the PATHS argument. If ENV var is "
- "found in the HINTS or PATHS section the environment variable var "
- "will be read and converted from a system environment variable to "
- "a cmake style list of paths. For example ENV PATH would be a way "
- "to list the system path variable. The argument "
- "after DOC will be used for the documentation string in "
- "the cache. "
- "PATH_SUFFIXES specifies additional subdirectories to check below "
- "each search path."
- "\n"
- "If NO_DEFAULT_PATH is specified, then no additional paths are "
- "added to the search. "
- "If NO_DEFAULT_PATH is not specified, the search process is as follows:\n"
- "1. Search paths specified in cmake-specific cache variables. "
- "These are intended to be used on the command line with a -DVAR=value. "
- "This can be skipped if NO_CMAKE_PATH is passed.\n"
- "XXX_EXTRA_PREFIX_ENTRY"
- " <prefix>/XXX_SUBDIR for each <prefix> in CMAKE_PREFIX_PATH\n"
- " CMAKE_XXX_PATH\n"
- " CMAKE_XXX_MAC_PATH\n"
- "2. Search paths specified in cmake-specific environment variables. "
- "These are intended to be set in the user's shell configuration. "
- "This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.\n"
- "XXX_EXTRA_PREFIX_ENTRY"
- " <prefix>/XXX_SUBDIR for each <prefix> in CMAKE_PREFIX_PATH\n"
- " CMAKE_XXX_PATH\n"
- " CMAKE_XXX_MAC_PATH\n"
- "3. Search the paths specified by the HINTS option. "
- "These should be paths computed by system introspection, such as a "
- "hint provided by the location of another item already found. "
- "Hard-coded guesses should be specified with the PATHS option.\n"
- "4. Search the standard system environment variables. "
- "This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument.\n"
- " PATH\n"
- " XXX_SYSTEM\n" // replace with "", LIB, or INCLUDE
- "5. Search cmake variables defined in the Platform files "
- "for the current system. This can be skipped if NO_CMAKE_SYSTEM_PATH "
- "is passed.\n"
- "XXX_EXTRA_PREFIX_ENTRY"
- " <prefix>/XXX_SUBDIR for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH\n"
- " CMAKE_SYSTEM_XXX_PATH\n"
- " CMAKE_SYSTEM_XXX_MAC_PATH\n"
- "6. Search the paths specified by the PATHS option "
- "or in the short-hand version of the command. "
- "These are typically hard-coded guesses.\n"
- ;
- this->GenericDocumentation += this->GenericDocumentationMacPolicy;
- this->GenericDocumentation += this->GenericDocumentationRootPath;
- this->GenericDocumentation += this->GenericDocumentationPathsOrder;
-}
-
-//----------------------------------------------------------------------------
-const char* cmFindBase::GetFullDocumentation() const
-{
- if(this->GenericDocumentation.empty())
- {
- const_cast<cmFindBase *>(this)->GenerateDocumentation();
- }
- return this->GenericDocumentation.c_str();
-}
-
-//----------------------------------------------------------------------------
bool cmFindBase::ParseArguments(std::vector<std::string> const& argsIn)
{
if(argsIn.size() < 2 )