mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-05 21:31:08 -06:00
Allow the Package Registry to be disabled (#14849)
When a project is packaged for redistribution the local package registries should not be updated or consulted. They are for developers. Add variables to disable use of package registries globally: * CMAKE_EXPORT_NO_PACKAGE_REGISTRY that disables the export(PACKAGE) command * CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY that disables the User Package Registry in all the find_package calls. * CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY that disables the System Package Registry in all the find_package calls. Update documentation and unit tests.
This commit is contained in:
committed by
Brad King
parent
d09fda5d91
commit
be8ae96098
11
Help/variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY.rst
Normal file
11
Help/variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
CMAKE_EXPORT_NO_PACKAGE_REGISTRY
|
||||
--------------------------------
|
||||
|
||||
Disable the :command:`export(PACKAGE)` command.
|
||||
|
||||
In some cases, for example for packaging and for system wide
|
||||
installations, it is not desirable to write the user package registry.
|
||||
If the :variable:`CMAKE_EXPORT_NO_PACKAGE_REGISTRY` variable is enabled,
|
||||
the :command:`export(PACKAGE)` command will do nothing.
|
||||
|
||||
See also :ref:`Disabling the Package Registry`.
|
||||
13
Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst
Normal file
13
Help/variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.rst
Normal file
@@ -0,0 +1,13 @@
|
||||
CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY
|
||||
--------------------------------------
|
||||
|
||||
Skip :ref:`User Package Registry` in :command:`find_package` calls.
|
||||
|
||||
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
|
||||
the :ref:`User Package Registry` as if they were called with the
|
||||
``NO_CMAKE_PACKAGE_REGISTRY`` argument.
|
||||
|
||||
See also :ref:`Disabling the Package Registry`.
|
||||
@@ -0,0 +1,13 @@
|
||||
CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY
|
||||
---------------------------------------------
|
||||
|
||||
Skip :ref:`System Package Registry` in :command:`find_package` calls.
|
||||
|
||||
In some cases, it is not desirable to use the
|
||||
:ref:`System Package Registry` when searching for packages. If the
|
||||
:variable:`CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY` variable is
|
||||
enabled, all the :command:`find_package` commands will skip
|
||||
the :ref:`System Package Registry` as if they were called with the
|
||||
``NO_CMAKE_SYSTEM_PACKAGE_REGISTRY`` argument.
|
||||
|
||||
See also :ref:`Disabling the Package Registry`.
|
||||
Reference in New Issue
Block a user