summaryrefslogtreecommitdiffstats
path: root/Source/cmFindPackageCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
committerBrad King <brad.king@kitware.com>2003-02-14 23:47:16 (GMT)
commita02574158d178615cf8fd642695e5099b6041049 (patch)
treedf9f52770e9c2ff771988ae1a91ec0b2287548da /Source/cmFindPackageCommand.h
parentdec0b5106611cbccd1f75c1fa3371d66bdd69a47 (diff)
downloadCMake-a02574158d178615cf8fd642695e5099b6041049.zip
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.gz
CMake-a02574158d178615cf8fd642695e5099b6041049.tar.bz2
ENH: Cleaned up documentation and formatted it for use by cmDocumentation.
Diffstat (limited to 'Source/cmFindPackageCommand.h')
-rw-r--r--Source/cmFindPackageCommand.h17
1 files changed, 13 insertions, 4 deletions
diff --git a/Source/cmFindPackageCommand.h b/Source/cmFindPackageCommand.h
index 93f054a..3dc659e 100644
--- a/Source/cmFindPackageCommand.h
+++ b/Source/cmFindPackageCommand.h
@@ -61,10 +61,19 @@ public:
virtual const char* GetFullDocumentation()
{
return
- "FIND_PACKAGE(<name> [major.minor])\n"
- "Finds and loads settings from an external project. <name>_FOUND will\n"
- "be set to indicate whether the package was found. Settings that\n"
- "can be used when <name>_FOUND is true are package-specific.";
+ " FIND_PACKAGE(<name> [major.minor])\n"
+ "Finds and loads settings from an external project. <name>_FOUND will "
+ "be set to indicate whether the package was found. Settings that "
+ "can be used when <name>_FOUND is true are package-specific. The "
+ "package is found through several steps. "
+ "Directories listed in CMAKE_MODULE_PATH are searched for files called "
+ "\"Find<name>.cmake\". If such a file is found, it is read and "
+ "processed by CMake, and is responsible for finding the package. "
+ "If no such file is found, it is expected that the package is another "
+ "project built by CMake that has a \"<name>Config.cmake\" file. "
+ "A cache entry called <name>_DIR is created and is expected to be set "
+ "to the directory containing this file. If the file is found, it is "
+ "read and processed by CMake to load the settings of the package.";
}
cmTypeMacro(cmFindPackageCommand, cmCommand);