summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2019-01-15 14:49:27 (GMT)
committerKitware Robot <kwrobot@kitware.com>2019-01-15 14:49:35 (GMT)
commitc07fa6d98c3ca2bc645c23c4a437d48d57d3eb8d (patch)
tree47ce9cc2dedc909682b28f309fb52ed4123fa720
parent2033c1e56fd3d9367fc4eb9a2595c3c592575d54 (diff)
parent427ebecdf5336b9915179464586d929850a95101 (diff)
downloadCMake-c07fa6d98c3ca2bc645c23c4a437d48d57d3eb8d.zip
CMake-c07fa6d98c3ca2bc645c23c4a437d48d57d3eb8d.tar.gz
CMake-c07fa6d98c3ca2bc645c23c4a437d48d57d3eb8d.tar.bz2
Merge topic 'find_package-doc-clarification'
427ebecdf5 Help/find_package: clarify intended behavior with REQUIRED QUIET Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2777
-rw-r--r--Help/command/find_package.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst
index 937a930..cafef8c 100644
--- a/Help/command/find_package.rst
+++ b/Help/command/find_package.rst
@@ -23,9 +23,9 @@ Finds and loads settings from an external project. ``<PackageName>_FOUND``
will be set to indicate whether the package was found. When the
package is found package-specific information is provided through
variables and :ref:`Imported Targets` documented by the package itself. The
-``QUIET`` option disables messages if the package cannot be found. The
-``REQUIRED`` option stops processing with an error message if the package
-cannot be found.
+``QUIET`` option disables informational messages, including those indicating
+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).