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 | |
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')
-rw-r--r-- | Modules/CMakeFindDependencyMacro.cmake | 2 | ||||
-rw-r--r-- | Modules/CMakePackageConfigHelpers.cmake | 12 | ||||
-rw-r--r-- | Modules/FindPackageHandleStandardArgs.cmake | 4 |
3 files changed, 9 insertions, 9 deletions
diff --git a/Modules/CMakeFindDependencyMacro.cmake b/Modules/CMakeFindDependencyMacro.cmake index 6a89fff..de1a332 100644 --- a/Modules/CMakeFindDependencyMacro.cmake +++ b/Modules/CMakeFindDependencyMacro.cmake @@ -14,7 +14,7 @@ CMakeFindDependencyMacro It is designed to be used in a :ref:`Package Configuration File <Config File Packages>` - (``<package>Config.cmake``). ``find_dependency`` forwards the correct + (``<PackageName>Config.cmake``). ``find_dependency`` forwards the correct parameters for ``QUIET`` and ``REQUIRED`` which were passed to the original :command:`find_package` call. Any additional arguments specified are forwarded to :command:`find_package`. 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. # diff --git a/Modules/FindPackageHandleStandardArgs.cmake b/Modules/FindPackageHandleStandardArgs.cmake index 67f6bd6..1722d6a 100644 --- a/Modules/FindPackageHandleStandardArgs.cmake +++ b/Modules/FindPackageHandleStandardArgs.cmake @@ -145,7 +145,7 @@ endmacro() # internal helper macro to generate the failure message when used in CONFIG_MODE: macro(_FPHSA_HANDLE_FAILURE_CONFIG_MODE) - # <name>_CONFIG is set, but FOUND is false, this means that some other of the REQUIRED_VARS was not found: + # <PackageName>_CONFIG is set, but FOUND is false, this means that some other of the REQUIRED_VARS was not found: if(${_NAME}_CONFIG) _FPHSA_FAILURE_MESSAGE("${FPHSA_FAIL_MESSAGE}: missing:${MISSING_VARS} (found ${${_NAME}_CONFIG} ${VERSION_MSG})") else() @@ -199,7 +199,7 @@ function(FIND_PACKAGE_HANDLE_STANDARD_ARGS _NAME _FIRST_ARG) set(FPHSA_FAIL_MESSAGE "DEFAULT_MSG") endif() - # In config-mode, we rely on the variable <package>_CONFIG, which is set by find_package() + # In config-mode, we rely on the variable <PackageName>_CONFIG, which is set by find_package() # when it successfully found the config-file, including version checking: if(FPHSA_CONFIG_MODE) list(INSERT FPHSA_REQUIRED_VARS 0 ${_NAME}_CONFIG) |