summaryrefslogtreecommitdiffstats
path: root/Modules/readme.txt
diff options
context:
space:
mode:
authorAlex Neundorf <neundorf@kde.org>2012-09-19 19:50:55 (GMT)
committerBrad King <brad.king@kitware.com>2012-09-28 13:21:36 (GMT)
commitae4ab62569e9b68d6976cb6ad4c1ad411ed8d3da (patch)
tree69711064b311c88731288d0f556a4bb15813ae86 /Modules/readme.txt
parent6508a8c804264304ee9db4e9239857fa1c663989 (diff)
downloadCMake-ae4ab62569e9b68d6976cb6ad4c1ad411ed8d3da.zip
CMake-ae4ab62569e9b68d6976cb6ad4c1ad411ed8d3da.tar.gz
CMake-ae4ab62569e9b68d6976cb6ad4c1ad411ed8d3da.tar.bz2
find_package: add support for a <package>_NOT_FOUND_MESSAGE variable
If a config-file sets <package>_FOUND to FALSE, it can now give a reason using the variable <package>_NOT_FOUND_MESSAGE, which is used by cmFindPackage and FPHSA. Alex
Diffstat (limited to 'Modules/readme.txt')
-rw-r--r--Modules/readme.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/Modules/readme.txt b/Modules/readme.txt
index ab5eaa1..4818031 100644
--- a/Modules/readme.txt
+++ b/Modules/readme.txt
@@ -18,6 +18,9 @@ XXX_VERSION_YY Expect Version YY if true. Make sure at most one of thes
XXX_WRAP_YY If False, do not try to use the relevent CMake wrapping command.
XXX_YY_FOUND If False, optional YY part of XXX sytem is not available.
XXX_FOUND Set to false, or undefined, if we haven't found, or don't want to use XXX.
+XXX_NOT_FOUND_MESSAGE Should be set by config-files in the case that it has set XXX_FOUND to FALSE.
+ The contained message will be printed by the find_package() command and by
+ find_package_handle_standard_args() to inform the user about the problem.
XXX_RUNTIME_LIBRARY_DIRS Optionally, the runtime library search path for use when running an executable linked to shared libraries.
The list should be used by user code to create the PATH on windows or LD_LIBRARY_PATH on unix.
This should not be a cache entry.