diff options
| author | Brad King <brad.king@kitware.com> | 2022-10-21 14:18:42 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2022-10-21 14:18:52 (GMT) |
| commit | 8a3951a5f45c08f066fed218b8db3de1637a72e1 (patch) | |
| tree | 7b9ea29203633fbee1fde5ba171925f09dcc0023 /Help | |
| parent | ab8e88191b893c6d3b9a749d49f8798ec383790b (diff) | |
| parent | 65dc8aa8b319ee42cd870ae868904de0a50ea53a (diff) | |
| download | CMake-8a3951a5f45c08f066fed218b8db3de1637a72e1.zip CMake-8a3951a5f45c08f066fed218b8db3de1637a72e1.tar.gz CMake-8a3951a5f45c08f066fed218b8db3de1637a72e1.tar.bz2 | |
Merge topic 'doc-find_package-search-path-versionadded'
65dc8aa8b3 Help: Mention CMake version for a recently-added `find_package` search path
93871cb5a9 Help: Reformat find_package search paths as Sphinx tables
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7810
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/find_package.rst | 52 |
1 files changed, 31 insertions, 21 deletions
diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 7f076f9..c99c73d 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -285,30 +285,40 @@ CMake constructs a set of possible installation prefixes for the package. Under each prefix several directories are searched for a configuration file. The tables below show the directories searched. Each entry is meant for installation trees following Windows (``W``), UNIX -(``U``), or Apple (``A``) conventions:: - - <prefix>/ (W) - <prefix>/(cmake|CMake)/ (W) - <prefix>/<name>*/ (W) - <prefix>/<name>*/(cmake|CMake)/ (W) - <prefix>/<name>*/(cmake|CMake)/<name>*/ (W) - <prefix>/(lib/<arch>|lib*|share)/cmake/<name>*/ (U) - <prefix>/(lib/<arch>|lib*|share)/<name>*/ (U) - <prefix>/(lib/<arch>|lib*|share)/<name>*/(cmake|CMake)/ (U) - <prefix>/<name>*/(lib/<arch>|lib*|share)/cmake/<name>*/ (W/U) - <prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/ (W/U) - <prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/(cmake|CMake)/ (W/U) +(``U``), or Apple (``A``) conventions: + +==================================================================== ========== + Entry Convention +==================================================================== ========== + ``<prefix>/`` W + ``<prefix>/(cmake|CMake)/`` W + ``<prefix>/<name>*/`` W + ``<prefix>/<name>*/(cmake|CMake)/`` W + ``<prefix>/<name>*/(cmake|CMake)/<name>*/`` [#]_ W + ``<prefix>/(lib/<arch>|lib*|share)/cmake/<name>*/`` U + ``<prefix>/(lib/<arch>|lib*|share)/<name>*/`` U + ``<prefix>/(lib/<arch>|lib*|share)/<name>*/(cmake|CMake)/`` U + ``<prefix>/<name>*/(lib/<arch>|lib*|share)/cmake/<name>*/`` W/U + ``<prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/`` W/U + ``<prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/(cmake|CMake)/`` W/U +==================================================================== ========== + +.. [#] .. versionadded:: 3.25 On systems supporting macOS :prop_tgt:`FRAMEWORK` and :prop_tgt:`BUNDLE`, the following directories are searched for Frameworks or Application Bundles -containing a configuration file:: - - <prefix>/<name>.framework/Resources/ (A) - <prefix>/<name>.framework/Resources/CMake/ (A) - <prefix>/<name>.framework/Versions/*/Resources/ (A) - <prefix>/<name>.framework/Versions/*/Resources/CMake/ (A) - <prefix>/<name>.app/Contents/Resources/ (A) - <prefix>/<name>.app/Contents/Resources/CMake/ (A) +containing a configuration file: + +=========================================================== ========== + Entry Convention +=========================================================== ========== + ``<prefix>/<name>.framework/Resources/`` A + ``<prefix>/<name>.framework/Resources/CMake/`` A + ``<prefix>/<name>.framework/Versions/*/Resources/`` A + ``<prefix>/<name>.framework/Versions/*/Resources/CMake/`` A + ``<prefix>/<name>.app/Contents/Resources/`` A + ``<prefix>/<name>.app/Contents/Resources/CMake/`` A +=========================================================== ========== In all cases the ``<name>`` is treated as case-insensitive and corresponds to any of the names specified (``<PackageName>`` or names given by ``NAMES``). |