From 93871cb5a937b6308940992746b4d66731096961 Mon Sep 17 00:00:00 2001 From: Alex Turbov Date: Thu, 20 Oct 2022 05:27:30 +0400 Subject: Help: Reformat find_package search paths as Sphinx tables --- Help/command/find_package.rst | 50 +++++++++++++++++++++++++------------------ 1 file 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:: - - / (W) - /(cmake|CMake)/ (W) - /*/ (W) - /*/(cmake|CMake)/ (W) - /*/(cmake|CMake)/*/ (W) - /(lib/|lib*|share)/cmake/*/ (U) - /(lib/|lib*|share)/*/ (U) - /(lib/|lib*|share)/*/(cmake|CMake)/ (U) - /*/(lib/|lib*|share)/cmake/*/ (W/U) - /*/(lib/|lib*|share)/*/ (W/U) - /*/(lib/|lib*|share)/*/(cmake|CMake)/ (W/U) +(``U``), or Apple (``A``) conventions: + +==================================================================== ========== + Entry Convention +==================================================================== ========== + ``/`` W + ``/(cmake|CMake)/`` W + ``/*/`` W + ``/*/(cmake|CMake)/`` W + ``/*/(cmake|CMake)/*/`` W + ``/(lib/|lib*|share)/cmake/*/`` U + ``/(lib/|lib*|share)/*/`` U + ``/(lib/|lib*|share)/*/(cmake|CMake)/`` U + ``/*/(lib/|lib*|share)/cmake/*/`` W/U + ``/*/(lib/|lib*|share)/*/`` W/U + ``/*/(lib/|lib*|share)/*/(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:: - - /.framework/Resources/ (A) - /.framework/Resources/CMake/ (A) - /.framework/Versions/*/Resources/ (A) - /.framework/Versions/*/Resources/CMake/ (A) - /.app/Contents/Resources/ (A) - /.app/Contents/Resources/CMake/ (A) +containing a configuration file: + +=========================================================== ========== + Entry Convention +=========================================================== ========== + ``/.framework/Resources/`` A + ``/.framework/Resources/CMake/`` A + ``/.framework/Versions/*/Resources/`` A + ``/.framework/Versions/*/Resources/CMake/`` A + ``/.app/Contents/Resources/`` A + ``/.app/Contents/Resources/CMake/`` A +=========================================================== ========== In all cases the ```` is treated as case-insensitive and corresponds to any of the names specified (```` or names given by ``NAMES``). -- cgit v0.12 From 65dc8aa8b319ee42cd870ae868904de0a50ea53a Mon Sep 17 00:00:00 2001 From: Alex Turbov Date: Thu, 20 Oct 2022 05:27:30 +0400 Subject: Help: Mention CMake version for a recently-added `find_package` search path Add a `versionadded` mark for the search path added by commit e55c154c5b (cmFindPackageCommand: Add one more search path, 2022-06-27, v3.25.0-rc1~339^2~1). Fixes: #24067 --- Help/command/find_package.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 6c99f21..c99c73d 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -294,7 +294,7 @@ Each entry is meant for installation trees following Windows (``W``), UNIX ``/(cmake|CMake)/`` W ``/*/`` W ``/*/(cmake|CMake)/`` W - ``/*/(cmake|CMake)/*/`` W + ``/*/(cmake|CMake)/*/`` [#]_ W ``/(lib/|lib*|share)/cmake/*/`` U ``/(lib/|lib*|share)/*/`` U ``/(lib/|lib*|share)/*/(cmake|CMake)/`` U @@ -303,6 +303,8 @@ Each entry is meant for installation trees following Windows (``W``), UNIX ``/*/(lib/|lib*|share)/*/(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: -- cgit v0.12