diff options
| author | Alex Turbov <i.zaufi@gmail.com> | 2022-10-20 01:27:30 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2022-10-20 15:17:46 (GMT) |
| commit | 93871cb5a937b6308940992746b4d66731096961 (patch) | |
| tree | 08dc70deda479a9395e1c8e941c42c3bb62e3d1d | |
| parent | 7d710abc87a83d96bb3b0f504338c2110d9afa19 (diff) | |
| download | CMake-93871cb5a937b6308940992746b4d66731096961.zip CMake-93871cb5a937b6308940992746b4d66731096961.tar.gz CMake-93871cb5a937b6308940992746b4d66731096961.tar.bz2 | |
Help: Reformat find_package search paths as Sphinx tables
| -rw-r--r-- | Help/command/find_package.rst | 50 |
1 files changed, 29 insertions, 21 deletions
diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 7f076f9..6c99f21 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -285,30 +285,38 @@ 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 +==================================================================== ========== 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``). |