diff options
| author | Brad King <brad.king@kitware.com> | 2015-04-15 15:32:26 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-04-17 14:46:25 (GMT) |
| commit | 84f06d0c84a7db85561cca044780d3ca92c9c3a3 (patch) | |
| tree | dc5aeba49abc15be94fd437f6abe13819dde9a45 /Modules/FindPackageHandleStandardArgs.cmake | |
| parent | a3ad275ce08784493267604d57207fce14602c48 (diff) | |
| download | CMake-84f06d0c84a7db85561cca044780d3ca92c9c3a3.zip CMake-84f06d0c84a7db85561cca044780d3ca92c9c3a3.tar.gz CMake-84f06d0c84a7db85561cca044780d3ca92c9c3a3.tar.bz2 | |
FPHSA: Document REQUIRED_VARS recommendation (#15352)
State explicitly that the variables specified are user-facing.
Diffstat (limited to 'Modules/FindPackageHandleStandardArgs.cmake')
| -rw-r--r-- | Modules/FindPackageHandleStandardArgs.cmake | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Modules/FindPackageHandleStandardArgs.cmake b/Modules/FindPackageHandleStandardArgs.cmake index a88eaec..1be38af 100644 --- a/Modules/FindPackageHandleStandardArgs.cmake +++ b/Modules/FindPackageHandleStandardArgs.cmake @@ -49,6 +49,10 @@ valid filepaths. ``REQUIRED_VARS <required-var>...`` Specify the variables which are required for this package. + These may be named in the generated failure message asking the + user to set the missing variable values. Therefore these should + typically be cache entries such as ``FOO_LIBRARY`` and not output + variables like ``FOO_LIBRARIES``. ``VERSION_VAR <version-var>`` Specify the name of a variable that holds the version of the package |