Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-20 12:53:55 +08:00
Code Issues Projects Releases Wiki Activity

Tutorial: Add documentation on Package helper functions

Browse Source 
Add documentation for the configure_package_config_file() and
write_basic_package_version_file() commands.

Update the comment for the installation of those files to allow a
stopping point for the code display.

Issue: #22663
This commit is contained in:
Joseph Snyder
2021-09-30 14:43:28 -04:00
parent 1bf25b5b5f
commit 6dade88d1c
2 changed files with 41 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
Help/guide/tutorial/Adding Export Configuration.rst
View File

@@ -82,6 +82,46 @@ bottom of the top-level ``CMakeLists.txt``:
:name: CMakeLists.txt-install-Config.cmake
:language: cmake
:start-after: # install the configuration targets
:end-before: # generate the config file
Next, we execute the :command:`configure_package_config_file`. This command
will configure a provided file but with a few specific differences from the
standard :command:`configure_file` way.
To properly utilize this function, the input file should have a single line
with the text ``@PACKAGE_INIT@`` in addition to the content that is desired.
That variable will be replaced with a block of code which turns set values into
relative paths. These values which are new can be referenced by the same name
but prepended with a ``PACKAGE_`` prefix.
.. literalinclude:: Step12/CMakeLists.txt
:caption: CMakeLists.txt
:name: CMakeLists.txt-configure-package-config.cmake
:language: cmake
:start-after: # install the configuration targets
:end-before: # generate the version file
The :command:`write_basic_package_version_file` is next. This command writes
a file which is used by the "find_package" document the version and
compatibility of the desired package. Here, we use the ``Tutorial_VERSION_*``
variables and say that it is compatible with ``AnyNewerVersion``, which
denotes that this version or any higher one are compatible with the requested
version.
.. literalinclude:: Step12/CMakeLists.txt
:caption: CMakeLists.txt
:name: CMakeLists.txt-basic-version-file.cmake
:language: cmake
:start-after: # generate the version file
:end-before: # install the generated configuration files
Finally, set both generated files to be installed:
.. literalinclude:: Step12/CMakeLists.txt
:caption: CMakeLists.txt
:name: CMakeLists.txt-install-configured-files.cmake
:language: cmake
:start-after: # install the generated configuration files
:end-before: # generate the export
At this point, we have generated a relocatable CMake Configuration for our

2
Help/guide/tutorial/Step12/CMakeLists.txt
View File

@@ -107,7 +107,7 @@ write_basic_package_version_file(
COMPATIBILITY AnyNewerVersion
)
# install the configuration file
# install the generated configuration files
install(FILES
${CMAKE_CURRENT_BINARY_DIR}/MathFunctionsConfig.cmake
${CMAKE_CURRENT_BINARY_DIR}/MathFunctionsConfigVersion.cmake