summaryrefslogtreecommitdiffstats
path: root/Source/cmFindPackageCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2006-10-26 15:39:56 (GMT)
committerBrad King <brad.king@kitware.com>2006-10-26 15:39:56 (GMT)
commitd9f1d4d71a66cff7a198ccddf85d90f928f59d52 (patch)
treeee586e645b75839cb761b70b4772ce26be34a5ce /Source/cmFindPackageCommand.h
parent5418998e46948d290dfb007c7ee65e54ae5635c7 (diff)
downloadCMake-d9f1d4d71a66cff7a198ccddf85d90f928f59d52.zip
CMake-d9f1d4d71a66cff7a198ccddf85d90f928f59d52.tar.gz
CMake-d9f1d4d71a66cff7a198ccddf85d90f928f59d52.tar.bz2
ENH: Added NO_MODULE and COMPONENTS options to improve flexibility of the command. Re-implemented argument parsing to be simpler and more robust.
Diffstat (limited to 'Source/cmFindPackageCommand.h')
-rw-r--r--Source/cmFindPackageCommand.h12
1 files changed, 7 insertions, 5 deletions
diff --git a/Source/cmFindPackageCommand.h b/Source/cmFindPackageCommand.h
index eadc0e8..9126c72 100644
--- a/Source/cmFindPackageCommand.h
+++ b/Source/cmFindPackageCommand.h
@@ -65,8 +65,8 @@ public:
virtual const char* GetFullDocumentation()
{
return
- " FIND_PACKAGE(<name> [major.minor] [QUIET]\n"
- " [REQUIRED [componets...]])\n"
+ " FIND_PACKAGE(<name> [major.minor] [QUIET] [NO_MODULE]\n"
+ " [[REQUIRED|COMPONENTS] [componets...]])\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 "
@@ -74,6 +74,7 @@ public:
"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. "
+ "This first step may be skipped by using the NO_MODULE option. "
"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 "
@@ -84,9 +85,10 @@ public:
"argument is specified. If <name>_DIR has been set to a directory "
"not containing a \"<name>Config.cmake\" file, an error is always "
"generated. If REQUIRED is specified and the package is not found, "
- "a FATAL_ERROR is generated and the configure step stops executing."
- " A package-specific list of components may be listed after the "
- "REQUIRED option.";
+ "a FATAL_ERROR is generated and the configure step stops executing. "
+ "A package-specific list of components may be listed after the "
+ "REQUIRED option, or after the COMPONENTS option if no REQUIRED "
+ "option is given.";
}
cmTypeMacro(cmFindPackageCommand, cmCommand);