diff options
| author | Robert Maynard <robert.maynard@kitware.com> | 2018-11-13 14:39:27 (GMT) |
|---|---|---|
| committer | Robert Maynard <robert.maynard@kitware.com> | 2019-07-09 13:38:35 (GMT) |
| commit | 1d00ba9ccf62087016e41f237dbae7f94d3aa1f6 (patch) | |
| tree | 74cf5845442a8c97f56e96c21d34851c696ff8c7 /Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst | |
| parent | 704e3a2ca89a3ea75b3cf55efe9bd5d6826168da (diff) | |
| download | CMake-1d00ba9ccf62087016e41f237dbae7f94d3aa1f6.zip CMake-1d00ba9ccf62087016e41f237dbae7f94d3aa1f6.tar.gz CMake-1d00ba9ccf62087016e41f237dbae7f94d3aa1f6.tar.bz2 | |
Find: find_package prefers variable CMAKE_FIND_USE_REGISTRY
CMake's find control flags should all have a consistent name.
To make this happen we are introducing `CMAKE_FIND_USE_REGISTRY`
and deprecating `CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY`.
Diffstat (limited to 'Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst')
| -rw-r--r-- | Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst b/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst index 9058471..ffb8a2c 100644 --- a/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst +++ b/Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst @@ -1,12 +1,23 @@ CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY -------------------------------------- -Skip :ref:`User Package Registry` in :command:`find_package` calls. +.. deprecated:: 3.16 + + Use the :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` variable instead. + +By default this variable is not set. If neither +:variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` nor +``CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY`` is set, then +:command:`find_package()` will use the `User Package Registry` unless the +`NO_CMAKE_PACKAGE_REGISTRY` option is provided. + +``CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY`` is ignored if +:variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` is set. In some cases, for example to locate only system wide installations, it is not desirable to use the :ref:`User Package Registry` when searching for packages. If the :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` -variable is enabled, all the :command:`find_package` commands will skip +variable is ``TRUE``, all the :command:`find_package` commands will skip the :ref:`User Package Registry` as if they were called with the ``NO_CMAKE_PACKAGE_REGISTRY`` argument. |