summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2018-10-04 19:01:59 (GMT)
committerBrad King <brad.king@kitware.com>2018-10-04 20:43:02 (GMT)
commit26dac50220ec677229c9569be959b9306c9967e2 (patch)
treecdd9fb21a7f26421091b4c21f90f8bcca7871245 /Help
parent11058a2e7cd3e673cc72d0f5bb1b214b4ecb4ad3 (diff)
downloadCMake-26dac50220ec677229c9569be959b9306c9967e2.zip
CMake-26dac50220ec677229c9569be959b9306c9967e2.tar.gz
CMake-26dac50220ec677229c9569be959b9306c9967e2.tar.bz2
Help: Remove redundant recommendation
We suggest that users prefer the basic signature in two places. Drop the latter and move its related content to a better section.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/find_package.rst16
1 files changed, 4 insertions, 12 deletions
diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst
index 1db386b..aba80b2 100644
--- a/Help/command/find_package.rst
+++ b/Help/command/find_package.rst
@@ -122,6 +122,10 @@ fatal error is generated and the configure step stops executing. If
``<PackageName>_DIR`` has been set to a directory not containing a
configuration file CMake will ignore it and search from scratch.
+Package maintainers providing CMake package configuration files are
+encouraged to name and install them such that the `Search Procedure`_
+outlined below will find them without requiring use of additional options.
+
Version Selection
^^^^^^^^^^^^^^^^^
@@ -205,18 +209,6 @@ For instance in order to select the highest version one can set::
before calling ``find_package``.
-Config mode provides an elaborate interface and search procedure.
-Much of the interface is provided for completeness and for use
-internally by find-modules loaded by Module mode. Most user code
-should simply call::
-
- find_package(<PackageName> [major[.minor]] [EXACT] [REQUIRED|QUIET])
-
-in order to find a package. Package maintainers providing CMake
-package configuration files are encouraged to name and install them
-such that the procedure outlined below will find them without
-requiring use of additional options.
-
Search Procedure
^^^^^^^^^^^^^^^^