From 46d266047c3f46cff9e42d44302c38463736c426 Mon Sep 17 00:00:00 2001 From: Brad King Date: Fri, 21 Jul 2006 15:16:23 -0400 Subject: [PATCH] ENH: Added documentation about XXX_FIND_COMPONENTS for FIND_PACKAGE. --- Modules/readme.txt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Modules/readme.txt b/Modules/readme.txt index 23e7dd64d..b9bd805d3 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.