Просмотр исходного кода

Help: Link to cmake-packages(7) from the Module creation documentation.

Stephen Kelly 11 лет назад
Родитель
Сommit
169f116632
2 измененных файлов с 5 добавлено и 1 удалено
  1. 3 1
      Help/manual/cmake-developer.7.rst
  2. 2 0
      Help/manual/cmake-packages.7.rst

+ 3 - 1
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

+ 2 - 0
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
 --------------------