summaryrefslogtreecommitdiffstats
path: root/Help/command/find_package.rst
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2021-08-08 05:04:23 (GMT)
committerCraig Scott <craig.scott@crascit.com>2021-08-08 22:01:47 (GMT)
commitb7d45677691cda2defdccd9272e595973f766162 (patch)
tree87bec0f7c8ed8d53415aeaa2a46b681d47afd585 /Help/command/find_package.rst
parentcc94429c61fcdff73ff78430692ff12ed1fff29b (diff)
downloadCMake-b7d45677691cda2defdccd9272e595973f766162.zip
CMake-b7d45677691cda2defdccd9272e595973f766162.tar.gz
CMake-b7d45677691cda2defdccd9272e595973f766162.tar.bz2
Help: Clarify find_package() component handling
Fixes: #22513
Diffstat (limited to 'Help/command/find_package.rst')
-rw-r--r--Help/command/find_package.rst25
1 files changed, 20 insertions, 5 deletions
diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst
index 7febd5d..bd26010 100644
--- a/Help/command/find_package.rst
+++ b/Help/command/find_package.rst
@@ -28,11 +28,26 @@ that the package cannot be found if it is not ``REQUIRED``. The ``REQUIRED``
option stops processing with an error message if the package cannot be found.
A package-specific list of required components may be listed after the
-``COMPONENTS`` option (or after the ``REQUIRED`` option if present).
+``COMPONENTS`` keyword. If any of these components are not able to be
+satisfied, the package overall is considered to be not found. If the
+``REQUIRED`` option is also present, this is treated as a fatal error,
+otherwise execution still continues. As a form of shorthand, if the
+``REQUIRED`` option is present, the ``COMPONENTS`` keyword can be omitted
+and the required components can be listed directly after ``REQUIRED``.
+
Additional optional components may be listed after
-``OPTIONAL_COMPONENTS``. Available components and their influence on
-whether a package is considered to be found are defined by the target
-package.
+``OPTIONAL_COMPONENTS``. If these cannot be satisfied, the package overall
+can still be considered found, as long as all required components are
+satisfied.
+
+The set of available components and their meaning are defined by the
+target package. Formally, it is up to the target package how to
+interpret the component information given to it, but it should follow
+the expectations stated above. For calls where no components are specified,
+there is no single expected behavior and target packages should clearly
+define what occurs in such cases. Common arrangements include assuming it
+should find all components, no components or some well-defined subset of the
+available components.
.. _FIND_PACKAGE_VERSION_FORMAT:
@@ -486,7 +501,7 @@ restores their original state before returning):
``<PackageName>_FIND_VERSION_EXACT``
True if ``EXACT`` option was given
``<PackageName>_FIND_COMPONENTS``
- List of requested components
+ List of specified components (required and optional)
``<PackageName>_FIND_REQUIRED_<c>``
True if component ``<c>`` is required,
false if component ``<c>`` is optional