diff options
author | Jean-Christophe Fillion-Robin <jchris.fillionr@kitware.com> | 2018-08-11 00:13:53 (GMT) |
---|---|---|
committer | Craig Scott <craig.scott@crascit.com> | 2018-08-14 10:54:56 (GMT) |
commit | 30d08bdce92960caa3fc68a3de95fffdf569e97b (patch) | |
tree | 64dae4ded21f9a60a29c8070ead620f35136d3e2 /Modules/CMakePackageConfigHelpers.cmake | |
parent | eba2b13a835000a614f21a1205a598462a4f8843 (diff) | |
download | CMake-30d08bdce92960caa3fc68a3de95fffdf569e97b.zip CMake-30d08bdce92960caa3fc68a3de95fffdf569e97b.tar.gz CMake-30d08bdce92960caa3fc68a3de95fffdf569e97b.tar.bz2 |
doc: Consistently use <PackageName> for describing the name of a package
Diffstat (limited to 'Modules/CMakePackageConfigHelpers.cmake')
-rw-r--r-- | Modules/CMakePackageConfigHelpers.cmake | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Modules/CMakePackageConfigHelpers.cmake b/Modules/CMakePackageConfigHelpers.cmake index 790d408..d5301d7 100644 --- a/Modules/CMakePackageConfigHelpers.cmake +++ b/Modules/CMakePackageConfigHelpers.cmake @@ -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. # |