summaryrefslogtreecommitdiffstats
path: root/Modules/readme.txt
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2006-07-21 19:16:23 (GMT)
committerBrad King <brad.king@kitware.com>2006-07-21 19:16:23 (GMT)
commit46d266047c3f46cff9e42d44302c38463736c426 (patch)
treed5927ae5260692b767b62e04085e5a5e1d107341 /Modules/readme.txt
parent299bbcad864599fc76701b2fbe1faea09220b682 (diff)
downloadCMake-46d266047c3f46cff9e42d44302c38463736c426.zip
CMake-46d266047c3f46cff9e42d44302c38463736c426.tar.gz
CMake-46d266047c3f46cff9e42d44302c38463736c426.tar.bz2
ENH: Added documentation about XXX_FIND_COMPONENTS for FIND_PACKAGE.
Diffstat (limited to 'Modules/readme.txt')
-rw-r--r--Modules/readme.txt11
1 files changed, 6 insertions, 5 deletions
diff --git a/Modules/readme.txt b/Modules/readme.txt
index 23e7dd6..b9bd805 100644
--- a/Modules/readme.txt
+++ b/Modules/readme.txt
@@ -71,8 +71,9 @@ XXX_FIND_REQUIRED to true before loading the FindXXX.cmake module. If
this variable is set the module should issue a FATAL_ERROR if the
package cannot be found. For each package-specific component, say
YYY, listed after the REQUIRED option a variable XXX_FIND_REQUIRED_YYY
-to true. This can be used by the FindXXX.cmake module to determine
-which sub-components of the package must be found. If neither the
-QUIET nor REQUIRED options are given then the FindXXX.cmake module
-should look for the package and complain without error if the module
-is not found.
+to true. The set of components listed will also be specified in a
+XXX_FIND_COMPONENTS variable. This can be used by the FindXXX.cmake
+module to determine which sub-components of the package must be found.
+If neither the QUIET nor REQUIRED options are given then the
+FindXXX.cmake module should look for the package and complain without
+error if the module is not found.