kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

FPHSA: Document REQUIRED_VARS recommendation (#15352) 

State explicitly that the variables specified are user-facing.
This commit is contained in:
Brad King 2015-04-15 11:32:26 -04:00
parent a3ad275ce0
commit 84f06d0c84
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Modules/FindPackageHandleStandardArgs.cmake
View File

@ -49,6 +49,10 @@ valid filepaths.
``REQUIRED_VARS <required-var>...`` ``REQUIRED_VARS <required-var>...``
Specify the variables which are required for this package. 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>`` ``VERSION_VAR <version-var>``
Specify the name of a variable that holds the version of the package Specify the name of a variable that holds the version of the package