reactos/CMake
1
0
Fork 0
mirror of https://github.com/reactos/CMake.git synced 2024-11-27 13:30:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

CMakeFindDependencyMacro: Document return() behavior and caveats

Browse Source 
The `find_dependency` macro is designed to be called from Package
Configuration Files, not from Find Modules.  The return() behavior is
particularly problematic for find modules.  Document this more clearly.

Issue: #17257
This commit is contained in:
Brad King 2017-09-08 10:41:46 -04:00
parent 07a05079d3
commit e48acfc501
1 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Modules/CMakeFindDependencyMacro.cmake
View File

@ -5,18 +5,29 @@
CMakeFindDependencyMacro
-------------------------
::
.. command:: find_dependency
The ``find_dependency()`` macro wraps a :command:`find_package` call for
a package dependency::
find_dependency(<dep> [...])
It is designed to be used in a
:ref:`Package Configuration File <Config File Packages>`
(``<package>Config.cmake``). ``find_dependency`` forwards the correct
parameters for ``QUIET`` and ``REQUIRED`` which were passed to
the original :command:`find_package` call. Any additional arguments
specified are forwarded to :command:`find_package`.
``find_dependency()`` wraps a :command:`find_package` call for a package
dependency. It is designed to be used in a <package>Config.cmake file, and it
forwards the correct parameters for QUIET and REQUIRED which were passed to
the original :command:`find_package` call. It also sets an informative
diagnostic message if the dependency could not be found.
If the dependency could not be found it sets an informative diagnostic
message and calls :command:`return` to end processing of the calling
package configuration file and return to the :command:`find_package`
command that loaded it.
Any additional arguments specified are forwarded to :command:`find_package`.
.. note::
The call to :command:`return` makes this macro unsuitable to call
from :ref:`Find Modules`.
#]=======================================================================]
macro(find_dependency dep)