summaryrefslogtreecommitdiff
path: root/Modules/FindPackageHandleStandardArgs.cmake
diff options
context:
space:
mode:
authorYury G. Kudryashov <urkud.urkud@gmail.com>2012-01-19 23:41:20 +0400
committerBrad King <brad.king@kitware.com>2012-01-20 09:09:47 -0500
commit26015baba36c8c48b2b72ca2b0ddb7ba0b37d6ad (patch)
treeabb1d6c506644031196016e36ab564b396f26be0 /Modules/FindPackageHandleStandardArgs.cmake
parenta6518c30e0ae0de17cd89dd52158501fc92d4455 (diff)
downloadcmake-26015baba36c8c48b2b72ca2b0ddb7ba0b37d6ad.tar.gz
FindPackageHandleStandardArgs: fix documentation
State explicitly what CONFIG_MODE argument does.
Diffstat (limited to 'Modules/FindPackageHandleStandardArgs.cmake')
-rw-r--r--Modules/FindPackageHandleStandardArgs.cmake6
1 files changed, 3 insertions, 3 deletions
diff --git a/Modules/FindPackageHandleStandardArgs.cmake b/Modules/FindPackageHandleStandardArgs.cmake
index 1acb021e80..b503357e32 100644
--- a/Modules/FindPackageHandleStandardArgs.cmake
+++ b/Modules/FindPackageHandleStandardArgs.cmake
@@ -33,9 +33,9 @@
# messages include information about the required version and the version
# which has been actually found, both if the version is ok or not.
# Use the option CONFIG_MODE if your FindXXX.cmake module is a wrapper for
-# a find_package(... NO_MODULE) call, in this case all the information
-# provided by the config-mode of find_package() will be evaluated
-# automatically.
+# a find_package(... NO_MODULE) call. In this case VERSION_VAR will be set
+# to <NAME>_VERSION and the macro will automatically check whether the
+# Config module was found.
# Via FAIL_MESSAGE a custom failure message can be specified, if this is not
# used, the default message will be displayed.
#