From 84f06d0c84a7db85561cca044780d3ca92c9c3a3 Mon Sep 17 00:00:00 2001
From: Brad King <brad.king@kitware.com>
Date: Wed, 15 Apr 2015 11:32:26 -0400
Subject: [PATCH] FPHSA: Document REQUIRED_VARS recommendation (#15352)

State explicitly that the variables specified are user-facing.
---
 Modules/FindPackageHandleStandardArgs.cmake | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Modules/FindPackageHandleStandardArgs.cmake b/Modules/FindPackageHandleStandardArgs.cmake
index a88eaecd2..1be38af2b 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