summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorStephen Kelly <steveire@gmail.com>2014-12-04 22:19:45 (GMT)
committerStephen Kelly <steveire@gmail.com>2014-12-04 22:31:59 (GMT)
commit169f116632321e99701986f48a19e836d2b9e710 (patch)
tree71d6ca0b32a109220b2fb488f171a277e55581d2 /Help
parent470c549c622ddddd0be3ae63945e40a1cad85923 (diff)
downloadCMake-169f116632321e99701986f48a19e836d2b9e710.zip
CMake-169f116632321e99701986f48a19e836d2b9e710.tar.gz
CMake-169f116632321e99701986f48a19e836d2b9e710.tar.bz2
Help: Link to cmake-packages(7) from the Module creation documentation.
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-developer.7.rst4
-rw-r--r--Help/manual/cmake-packages.7.rst2
2 files changed, 5 insertions, 1 deletions
diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst
index 672c9b7..c7bafc0 100644
--- a/Help/manual/cmake-developer.7.rst
+++ b/Help/manual/cmake-developer.7.rst
@@ -720,7 +720,9 @@ by the :command:`find_package` command when invoked for ``<package>``.
The primary task of a find module is to determine whether a package
exists on the system, set the ``<package>_FOUND`` variable to reflect
this and provide any variables, macros and imported targets required to
-use the package.
+use the package. A find module is useful in cases where an upstream
+library does not provide a
+:ref:`config file package <Config File Packages>`.
The traditional approach is to use variables for everything, including
libraries and executables: see the `Standard Variable Names`_ section
diff --git a/Help/manual/cmake-packages.7.rst b/Help/manual/cmake-packages.7.rst
index 0d18fd7..fba1d61 100644
--- a/Help/manual/cmake-packages.7.rst
+++ b/Help/manual/cmake-packages.7.rst
@@ -76,6 +76,8 @@ By setting the :variable:`CMAKE_DISABLE_FIND_PACKAGE_<PackageName>` variable to
``TRUE``, the ``PackageName`` package will not be searched, and will always
be ``NOTFOUND``.
+.. _`Config File Packages`:
+
Config-file Packages
--------------------