diff options
| author | Brad King <brad.king@kitware.com> | 2022-07-25 16:02:12 +0000 |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2022-07-25 12:02:19 -0400 |
| commit | 22c535299019eb835dd0d5793d3b40e59d0cc6ee (patch) | |
| tree | 6c9dace7c3de15545c145bcc0d8d46936ee94c76 | |
| parent | 7ed8c2de6a755bc05d43ee1d5caf566b14c9209a (diff) | |
| parent | 4f7a0c25d28621ef63c6674f8792ee96f029fce7 (diff) | |
| download | cmake-22c535299019eb835dd0d5793d3b40e59d0cc6ee.tar.gz | |
Merge topic 'doc-find_package-BYPASS_PROVIDER' into release-3.24
4f7a0c25d2 Help: Document BYPASS_PROVIDER keyword for find_package()
76370e06b8 Help: Minor grammar fix for the Using Dependencies manual
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7501
| -rw-r--r-- | Help/command/find_package.rst | 14 | ||||
| -rw-r--r-- | Help/guide/using-dependencies/index.rst | 2 |
2 files changed, 13 insertions, 3 deletions
diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 35e3c51a92..ee52c4189c 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -103,8 +103,9 @@ Basic Signature [REQUIRED] [[COMPONENTS] [components...]] [OPTIONAL_COMPONENTS components...] [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)] + [GLOBAL] [NO_POLICY_SCOPE] - [GLOBAL]) + [BYPASS_PROVIDER]) The basic signature is supported by both Module and Config modes. The ``MODULE`` keyword implies that only Module mode can be used to find @@ -181,6 +182,14 @@ only take the single version at the lower end of the range into account. See the :command:`cmake_policy` command documentation for discussion of the ``NO_POLICY_SCOPE`` option. +.. versionadded:: 3.24 + The ``BYPASS_PROVIDER`` keyword is only allowed when ``find_package()`` is + being called by a :ref:`dependency provider <dependency_providers>`. + It can be used by providers to call the built-in ``find_package()`` + implementation directly and prevent that call from being re-routed back to + itself. Future versions of CMake may detect attempts to use this keyword + from places other than a dependency provider and halt with a fatal error. + .. _`full signature`: Full Signature @@ -192,8 +201,9 @@ Full Signature [REQUIRED] [[COMPONENTS] [components...]] [OPTIONAL_COMPONENTS components...] [CONFIG|NO_MODULE] - [NO_POLICY_SCOPE] [GLOBAL] + [NO_POLICY_SCOPE] + [BYPASS_PROVIDER] [NAMES name1 [name2 ...]] [CONFIGS config1 [config2 ...]] [HINTS path1 [path2 ... ]] diff --git a/Help/guide/using-dependencies/index.rst b/Help/guide/using-dependencies/index.rst index 6cab7ef479..bb519ad135 100644 --- a/Help/guide/using-dependencies/index.rst +++ b/Help/guide/using-dependencies/index.rst @@ -388,7 +388,7 @@ can still be built out-of-the-box. The developer, on the other hand, may be much more interested in controlling *how* a dependency is provided to the project. You might want to use a -particular version of a package that you built themself. You might want +particular version of a package that you built yourself. You might want to use a third party package manager. You might want to redirect some requests to a different URL on a system you control for security or performance reasons. CMake supports these sort of scenarios through |