diff options
| author | Brad King <brad.king@kitware.com> | 2009-02-16 10:33:09 -0500 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2009-02-16 10:33:09 -0500 |
| commit | 0d34d44917476db49538313f75d2d9d345f3cdf8 (patch) | |
| tree | 049c6faf4e4317349c3bd75ae8e684917a6c85e1 /Modules/readme.txt | |
| parent | 1b499f0019d748c7ea47fafd64a69c7fa0021a06 (diff) | |
| download | cmake-0d34d44917476db49538313f75d2d9d345f3cdf8.tar.gz | |
STYLE: Note find_package COMPONENTS in modules doc
This mentions the COMPONENTS option of find_package in the module author
documentation file "Modules/readme.txt". See issue #8539.
Diffstat (limited to 'Modules/readme.txt')
| -rw-r--r-- | Modules/readme.txt | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Modules/readme.txt b/Modules/readme.txt index 8e4474eadc..ccfa127dd4 100644 --- a/Modules/readme.txt +++ b/Modules/readme.txt @@ -68,7 +68,7 @@ line. A FindXXX.cmake module will typically be loaded by the command FIND_PACKAGE(XXX [major[.minor[.patch[.tweak]]]] [EXACT] - [QUIET] [REQUIRED [components...]]) + [QUIET] [[REQUIRED|COMPONENTS] [components...]]) If any version numbers are given to the command it will set the following variables before loading the module: @@ -96,7 +96,8 @@ 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. The set of components listed will also be specified in a +to true. The set of components listed after either the REQUIRED +option or the COMPONENTS option will 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 |