mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-06 05:40:54 -06:00
1d00ba9ccf
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`.
30 lines
1.2 KiB
ReStructuredText
30 lines
1.2 KiB
ReStructuredText
CMAKE_FIND_USE_PACKAGE_REGISTRY
|
|
-------------------------------
|
|
|
|
Controls the searching the :ref:`User Package Registry` by the :command:`find_package`
|
|
command.
|
|
|
|
By default this variable is not set and the behavior will fall back
|
|
to that determined by the deprecated :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY`
|
|
variable. If that is also not set, then `find_package()` will use the
|
|
`User Package Registry` unless the `NO_CMAKE_PACKAGE_REGISTRY` option
|
|
is provided.
|
|
|
|
This variable takes precedence over :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY`
|
|
when both are 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_USE_PACKAGE_REGISTRY`
|
|
variable is ``FALSE``, 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.
|
|
|
|
See also :ref:`Disabling the Package Registry`.
|
|
|
|
See also the :variable:`CMAKE_FIND_USE_CMAKE_PATH`,
|
|
:variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH`,
|
|
:variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH`,
|
|
:variable:`CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH`,
|
|
and :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` variables.
|