Commit 84f06d0c authored by Brad King's avatar Brad King

FPHSA: Document REQUIRED_VARS recommendation (#15352)

State explicitly that the variables specified are user-facing.
parent a3ad275c
......@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment