CMake/Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst
James Johnston 3bb707f0a1 Help: Improve formatting of variable documentation
Improve formatting, primarily by:

* Adding links to relevant commands, properties, generators, and so on.
* Converting code, symbols, paths, and so on to fixed-width fonts.
* Hard wrapping lines to 80 characters or less.
2015-08-21 09:32:08 -04:00

20 lines
1012 B
ReStructuredText

CMAKE_FIND_PACKAGE_WARN_NO_MODULE
---------------------------------
Tell :command:`find_package` to warn if called without an explicit mode.
If :command:`find_package` is called without an explicit mode option
(``MODULE``, ``CONFIG``, or ``NO_MODULE``) and no ``Find<pkg>.cmake`` module
is in :variable:`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
:command:`find_package` to warn when it implicitly assumes Config mode. This
helps developers enforce use of an explicit mode in all calls to
:command:`find_package` within a project.