aboutsummaryrefslogtreecommitdiff
path: root/modules/ECMPackageConfigHelpers.cmake
diff options
context:
space:
mode:
authorl10n daemon script <scripty@kde.org>2015-11-08 21:01:33 +0000
committerl10n daemon script <scripty@kde.org>2015-11-08 21:01:33 +0000
commit7feccae76e01a65b406995b5ba9526fe9ade4299 (patch)
tree99011137f4dedcf4bf242e167ac7dc70d9136b8e /modules/ECMPackageConfigHelpers.cmake
parenta1bb0b0488843165e606771b75a3a67ba8a131a6 (diff)
parentc88bc78e0ca3834c46b89ca9d14b404751da5d4a (diff)
downloadextra-cmake-modules-5.16.0-rc2.tar.gz
extra-cmake-modules-5.16.0-rc2.tar.bz2
Merge remote-tracking branch 'origin/master' into local_releasev5.16.0-rc2v5.16.0
Diffstat (limited to 'modules/ECMPackageConfigHelpers.cmake')
-rw-r--r--modules/ECMPackageConfigHelpers.cmake31
1 files changed, 21 insertions, 10 deletions
diff --git a/modules/ECMPackageConfigHelpers.cmake b/modules/ECMPackageConfigHelpers.cmake
index bc99d1cb..d1d0408f 100644
--- a/modules/ECMPackageConfigHelpers.cmake
+++ b/modules/ECMPackageConfigHelpers.cmake
@@ -5,7 +5,9 @@
# Helper macros for generating CMake package config files.
#
# ``write_basic_package_version_file()`` is the same as the one provided by the
-# CMakePackageConfigHelpers module in CMake; see that module's documentation for
+# `CMakePackageConfigHelpers
+# <http://www.cmake.org/cmake/help/v2.8.12/cmake.html#module:CMakePackageConfigHelpers>`_
+# module in CMake; see that module's documentation for
# more information.
#
# ::
@@ -18,7 +20,23 @@
#
#
# This behaves in the same way as configure_package_config_file() from CMake
-# 2.8.12, except that it adds an extra helper macro: find_dependency().
+# 2.8.12, except that it adds an extra helper macro: find_dependency(). It is
+# highly recommended that you read the `documentation for
+# CMakePackageConfigHelpers
+# <http://www.cmake.org/cmake/help/v2.8.12/cmake.html#module:CMakePackageConfigHelpers>`_
+# for more information, particularly with regard to the PATH_VARS argument.
+#
+# Note that there is no argument that will disable the find_dependency() macro;
+# if you do not require this macro, you should use
+# ``configure_package_config_file`` from the CMakePackageConfigHelpers module.
+#
+# CMake 3.0 includes a CMakeFindDependencyMacro module that provides the
+# find_dependency() macro (which you can ``include()`` in your package config
+# file), so this file is only useful for projects wishing to provide config
+# files that will work with CMake 2.8.12.
+#
+# Additional Config File Macros
+# =============================
#
# ::
#
@@ -29,14 +47,7 @@
# REQUIRED which were passed to the original find_package() call. It also sets
# an informative diagnostic message if the dependency could not be found.
#
-# Note that there is no argument to disable the find_dependency() macro; if you
-# do not require this macro, you should just use the CMakeFindDependencyMacro
-# module directly.
-#
-# CMake 3.0.0 will include a CMakeFindDependencyMacro module that will provide
-# the find_dependency() macro (which you can include() in your package config
-# file), so this file is only useful for projects whose minimum required version
-# is 2.8.12.
+# Since pre-1.0.0.
#=============================================================================
# Copyright 2014 Alex Merry <alex.merry@kdemail.net>