From c20d22c951e61a06701f6c2201add7c11915e7c5 Mon Sep 17 00:00:00 2001 From: Alex Merry Date: Thu, 10 Apr 2014 21:38:09 +0100 Subject: Add documentation generation using Sphinx This is deliberately modelled very closely on CMake's documentation system. It's a hefty patch, because it involved changing all the documentation to be in reStructuredText format. I also cleaned up the copyright/license statements at the same time. Note that the find modules contain the full license, due to the fact that ecm_use_find_module() copies them out of the ECM distribution. --- modules/ECMPackageConfigHelpers.cmake | 44 +++++++++++++++++++++++++++++------ 1 file changed, 37 insertions(+), 7 deletions(-) (limited to 'modules/ECMPackageConfigHelpers.cmake') diff --git a/modules/ECMPackageConfigHelpers.cmake b/modules/ECMPackageConfigHelpers.cmake index 2ccf32f6..da65c3ea 100644 --- a/modules/ECMPackageConfigHelpers.cmake +++ b/modules/ECMPackageConfigHelpers.cmake @@ -1,11 +1,28 @@ -# - ECM_CONFIGURE_PACKAGE_CONFIG_FILE(), WRITE_BASIC_PACKAGE_VERSION_FILE() +#.rst: +# ECMPackageConfigHelpers +# ----------------------- # -# WRITE_BASIC_PACKAGE_VERSION_FILE() is actually just the macro from the -# CMakePackageConfigHelpers module. +# Helper macros for generating CMake package config files. # -# ECM_CONFIGURE_PACKAGE_CONFIG_FILE() behaves like -# CONFIGURE_PACKAGE_CONFIG_FILE() from CMake 2.8.12, except that it adds an -# extra helper macro: find_dependency(). +# ``write_basic_package_version_file()`` is the same as the one provided by the +# CMakePackageConfigHelpers module in CMake; see that module's documentation for +# more information. +# +# :: +# +# ecm_configure_package_config_file( +# INSTALL_DESTINATION +# [PATH_VARS [ [...]] +# [NO_SET_AND_CHECK_MACRO] +# [NO_CHECK_REQUIRED_COMPONENTS_MACRO]) +# +# +# 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(). +# +# :: +# +# find_dependency( [ [EXACT]]) # # find_dependency() should be used instead of find_package() to find package # dependencies. It forwards the correct parameters for EXACT, QUIET and @@ -17,10 +34,23 @@ # module directly. # # CMake 3.0.0 will include a CMakeFindDependencyMacro module that will provide -# the find_dependency macro (which you can include() in your *Config.cmake +# 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. + +#============================================================================= +# Copyright 2014 Alex Merry +# Copyright 2013 Stephen Kelly +# +# Distributed under the OSI-approved BSD License (the "License"); +# see accompanying file COPYING-CMAKE-SCRIPTS for details. # +# This software is distributed WITHOUT ANY WARRANTY; without even the +# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +# See the License for more information. +#============================================================================= +# (To distribute this file outside of extra-cmake-modules, substitute the full +# License text for the above reference.) include(${CMAKE_ROOT}/Modules/CMakePackageConfigHelpers.cmake) -- cgit v1.2.1