ENH: Added documentation about XXX_FIND_COMPONENTS for FIND_PACKAGE.

This commit is contained in:
Brad King 2006-07-21 15:16:23 -04:00
parent 299bbcad86
commit 46d266047c
1 changed files with 6 additions and 5 deletions

View File

@ -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 this variable is set the module should issue a FATAL_ERROR if the
package cannot be found. For each package-specific component, say package cannot be found. For each package-specific component, say
YYY, listed after the REQUIRED option a variable XXX_FIND_REQUIRED_YYY 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 to true. The set of components listed will also be specified in a
which sub-components of the package must be found. If neither the XXX_FIND_COMPONENTS variable. This can be used by the FindXXX.cmake
QUIET nor REQUIRED options are given then the FindXXX.cmake module module to determine which sub-components of the package must be found.
should look for the package and complain without error if the module If neither the QUIET nor REQUIRED options are given then the
is not found. FindXXX.cmake module should look for the package and complain without
error if the module is not found.