summaryrefslogtreecommitdiffstats
path: root/Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 15:17:36 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-15 18:12:03 (GMT)
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadCMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst')
-rw-r--r--Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst b/Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst
new file mode 100644
index 0000000..5d7599c
--- /dev/null
+++ b/Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst
@@ -0,0 +1,19 @@
+CMAKE_FIND_PACKAGE_WARN_NO_MODULE
+---------------------------------
+
+Tell find_package to warn if called without an explicit mode.
+
+If find_package is called without an explicit mode option (MODULE,
+CONFIG or NO_MODULE) and no Find<pkg>.cmake module is in
+CMAKE_MODULE_PATH then CMake implicitly assumes that the caller
+intends to search for a package configuration file. If no package
+configuration file is found then the wording of the failure message
+must account for both the case that the package is really missing and
+the case that the project has a bug and failed to provide the intended
+Find module. If instead the caller specifies an explicit mode option
+then the failure message can be more specific.
+
+Set CMAKE_FIND_PACKAGE_WARN_NO_MODULE to TRUE to tell find_package to
+warn when it implicitly assumes Config mode. This helps developers
+enforce use of an explicit mode in all calls to find_package within a
+project.