summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-12-18 21:34:33 (GMT)
committerBrad King <brad.king@kitware.com>2023-12-18 21:35:46 (GMT)
commit1a6303aa8c17703d24b6e375cd143a9e8db661e1 (patch)
tree4133c90fa32dcc7bcb38c097018777df622b4cb7 /Modules
parentedb10c53256a4c308548af298eafc9ddf90b3bda (diff)
downloadCMake-1a6303aa8c17703d24b6e375cd143a9e8db661e1.zip
CMake-1a6303aa8c17703d24b6e375cd143a9e8db661e1.tar.gz
CMake-1a6303aa8c17703d24b6e375cd143a9e8db661e1.tar.bz2
CMakePackageConfigHelpers: Fix generate_apple_platform_selection_file docs
Previously the documentation was not rendered correctly.
Diffstat (limited to 'Modules')
-rw-r--r--Modules/CMakePackageConfigHelpers.cmake88
1 files changed, 45 insertions, 43 deletions
diff --git a/Modules/CMakePackageConfigHelpers.cmake b/Modules/CMakePackageConfigHelpers.cmake
index ab38820..386c39d 100644
--- a/Modules/CMakePackageConfigHelpers.cmake
+++ b/Modules/CMakePackageConfigHelpers.cmake
@@ -193,64 +193,66 @@ point to create more sophisticated custom ``ConfigVersion.cmake`` files.
Generating an Apple Platform Selection File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. versionadded:: 3.29
-
.. command:: generate_apple_platform_selection_file
- Create an Apple platform selection file:
+ .. versionadded:: 3.29
- generate_apple_platform_selection_file(<filename>
- INSTALL_DESTINATION <path>
- [MACOS_CONFIG_FILE <file>]
- [IOS_CONFIG_FILE <file>]
- [IOS_SIMULATOR_CONFIG_FILE <file>]
- [TVOS_CONFIG_FILE <file>]
- [TVOS_SIMULATOR_CONFIG_FILE <file>]
- [WATCHOS_CONFIG_FILE <file>]
- [WATCHOS_SIMULATOR_CONFIG_FILE <file>]
- [VISIONOS_CONFIG_FILE <file>]
- [VISIONOS_SIMULATOR_CONFIG_FILE <file>]
- )
+ Create an Apple platform selection file:
+
+ .. code-block:: cmake
+
+ generate_apple_platform_selection_file(<filename>
+ INSTALL_DESTINATION <path>
+ [MACOS_CONFIG_FILE <file>]
+ [IOS_CONFIG_FILE <file>]
+ [IOS_SIMULATOR_CONFIG_FILE <file>]
+ [TVOS_CONFIG_FILE <file>]
+ [TVOS_SIMULATOR_CONFIG_FILE <file>]
+ [WATCHOS_CONFIG_FILE <file>]
+ [WATCHOS_SIMULATOR_CONFIG_FILE <file>]
+ [VISIONOS_CONFIG_FILE <file>]
+ [VISIONOS_SIMULATOR_CONFIG_FILE <file>]
+ )
-Writes a file for use as ``<PackageName>Config.cmake`` which can include an
-Apple-platform-specific ``<PackageName>Config.cmake`` from a different
-directory. This can be used in conjunction with the ``XCFRAMEWORK_LOCATION``
-argument of :command:`export(SETUP)` to export packages in a way that a project
-built for any Apple platform can use them.
+ Writes a file for use as ``<PackageName>Config.cmake`` which can include an
+ Apple-platform-specific ``<PackageName>Config.cmake`` from a different
+ directory. This can be used in conjunction with the ``XCFRAMEWORK_LOCATION``
+ argument of :command:`export(SETUP)` to export packages in a way that a project
+ built for any Apple platform can use them.
-``INSTALL_DESTINATION <path>``
- Path that the file will be installed to.
+ ``INSTALL_DESTINATION <path>``
+ Path that the file will be installed to.
-``MACOS_CONFIG_FILE <file>``
- File to include if the platform is macOS.
+ ``MACOS_CONFIG_FILE <file>``
+ File to include if the platform is macOS.
-``IOS_CONFIG_FILE <file>``
- File to include if the platform is iOS.
+ ``IOS_CONFIG_FILE <file>``
+ File to include if the platform is iOS.
-``IOS_SIMULATOR_CONFIG_FILE <file>``
- File to include if the platform is iOS Simulator.
+ ``IOS_SIMULATOR_CONFIG_FILE <file>``
+ File to include if the platform is iOS Simulator.
-``TVOS_CONFIG_FILE <file>``
- File to include if the platform is tvOS.
+ ``TVOS_CONFIG_FILE <file>``
+ File to include if the platform is tvOS.
-``TVOS_SIMULATOR_CONFIG_FILE <file>``
- File to include if the platform is tvOS Simulator.
+ ``TVOS_SIMULATOR_CONFIG_FILE <file>``
+ File to include if the platform is tvOS Simulator.
-``WATCHOS_CONFIG_FILE <file>``
- File to include if the platform is watchOS.
+ ``WATCHOS_CONFIG_FILE <file>``
+ File to include if the platform is watchOS.
-``WATCHOS_SIMULATOR_CONFIG_FILE <file>``
- File to include if the platform is watchOS Simulator.
+ ``WATCHOS_SIMULATOR_CONFIG_FILE <file>``
+ File to include if the platform is watchOS Simulator.
-``VISIONOS_CONFIG_FILE <file>``
- File to include if the platform is visionOS.
+ ``VISIONOS_CONFIG_FILE <file>``
+ File to include if the platform is visionOS.
-``VISIONOS_SIMULATOR_CONFIG_FILE <file>``
- File to include if the platform is visionOS Simulator.
+ ``VISIONOS_SIMULATOR_CONFIG_FILE <file>``
+ File to include if the platform is visionOS Simulator.
-If any of the optional config files are not specified, and the consuming
-project is built for their corresponding platform, an error will be thrown
-when including the generated file.
+ If any of the optional config files are not specified, and the consuming
+ project is built for their corresponding platform, an error will be thrown
+ when including the generated file.
Example Generating Package Files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^