mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-06 05:40:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc: Consistently use <PackageName> for describing the name of a package

Browse Source
This commit is contained in:
Jean-Christophe Fillion-Robin
2018-08-10 20:13:53 -04:00
committed by Craig Scott
parent eba2b13a83
commit 30d08bdce9
10 changed files with 84 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Modules/CMakePackageConfigHelpers.cmake
View File

@@ -27,10 +27,10 @@
# )
#
# ``configure_package_config_file()`` should be used instead of the plain
# :command:`configure_file()` command when creating the ``<Name>Config.cmake``
# or ``<Name>-config.cmake`` file for installing a project or library. It helps
# making the resulting package relocatable by avoiding hardcoded paths in the
# installed ``Config.cmake`` file.
# :command:`configure_file()` command when creating the ``<PackageName>Config.cmake``
# or ``<PackageName>-config.cmake`` file for installing a project or library.
# It helps making the resulting package relocatable by avoiding hardcoded paths
# in the installed ``Config.cmake`` file.
#
# In a ``FooConfig.cmake`` file there may be code like this to make the install
# destinations know to the using project:
@@ -101,7 +101,7 @@
# When using the ``NO_SET_AND_CHECK_MACRO``, this macro is not generated
# into the ``FooConfig.cmake`` file.
#
# ``check_required_components(<package_name>)`` should be called at the end of
# ``check_required_components(<PackageName>)`` should be called at the end of
# the ``FooConfig.cmake`` file. This macro checks whether all requested,
# non-optional components have been found, and if this is not the case, sets
# the ``Foo_FOUND`` variable to ``FALSE``, so that the package is considered to
@@ -127,7 +127,7 @@
# COMPATIBILITY <AnyNewerVersion|SameMajorVersion|SameMinorVersion|ExactVersion> )
#
#
# Writes a file for use as ``<package>ConfigVersion.cmake`` file to
# Writes a file for use as ``<PackageName>ConfigVersion.cmake`` file to
# ``<filename>``. See the documentation of :command:`find_package()` for
# details on this.
#