mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-06 05:40:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'doc-find_dependency-return'

Browse Source 
e48acfc5 CMakeFindDependencyMacro: Document return() behavior and caveats
07a05079 CMakeFindDependencyMacro: Convert documentation to bracket comment

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !1245
This commit is contained in:
Brad King
2017-09-11 11:55:37 +00:00
committed by Kitware Robot
parent 28adf3833c e48acfc501
commit 1c9d3c0d32
1 changed files with 28 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
Modules/CMakeFindDependencyMacro.cmake
View File

@@ -1,23 +1,34 @@
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.
#.rst:
# CMakeFindDependencyMacro
# -------------------------
#
# ::
#
# find_dependency(<dep> [...])
#
#
# ``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.
#
# Any additional arguments specified are forwarded to :command:`find_package`.
#
#[=======================================================================[.rst:
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`.
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.
.. note::
The call to :command:`return` makes this macro unsuitable to call
from :ref:`Find Modules`.
#]=======================================================================]
macro(find_dependency dep)
if (NOT ${dep}_FOUND)