diff options
| author | Daniele E. Domenichelli <daniele.domenichelli@iit.it> | 2014-04-02 14:32:54 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-05-12 13:50:01 (GMT) |
| commit | be8ae96098c58cf96ed71badba94e7b45f273f3c (patch) | |
| tree | beac603dc9dbfe83ec71db2b8aae5bc54ccce8d6 /Help/command | |
| parent | d09fda5d91e92155ef674dde97a66547cc750e9f (diff) | |
| download | CMake-be8ae96098c58cf96ed71badba94e7b45f273f3c.zip CMake-be8ae96098c58cf96ed71badba94e7b45f273f3c.tar.gz CMake-be8ae96098c58cf96ed71badba94e7b45f273f3c.tar.bz2 | |
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.
Diffstat (limited to 'Help/command')
| -rw-r--r-- | Help/command/export.rst | 5 | ||||
| -rw-r--r-- | Help/command/find_package.rst | 8 |
2 files changed, 10 insertions, 3 deletions
diff --git a/Help/command/export.rst b/Help/command/export.rst index 6b83587..d4bab35 100644 --- a/Help/command/export.rst +++ b/Help/command/export.rst @@ -51,4 +51,7 @@ projects find and use a package from the current project's build tree without help from the user. Note that the entry in the package registry that this command creates works only in conjunction with a package configuration file (<name>Config.cmake) that works with the -build tree. +build tree. 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 ``export(PACKAGE)`` command will do nothing. diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 5d9aea6..190d05c 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -272,7 +272,9 @@ enabled. (This step is implemented only on Windows.) 6. Search paths stored in the CMake :ref:`User Package Registry`. - This can be skipped if ``NO_CMAKE_PACKAGE_REGISTRY`` is passed. + This can be skipped if ``NO_CMAKE_PACKAGE_REGISTRY`` is passed or by + setting the :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` + to ``TRUE``. See the :manual:`cmake-packages(7)` manual for details on the user package registry. @@ -285,7 +287,9 @@ enabled. CMAKE_SYSTEM_APPBUNDLE_PATH 8. Search paths stored in the CMake :ref:`System Package Registry`. - This can be skipped if ``NO_CMAKE_SYSTEM_PACKAGE_REGISTRY`` is passed. + This can be skipped if ``NO_CMAKE_SYSTEM_PACKAGE_REGISTRY`` is passed + or by setting the + :variable:`CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY` to ``TRUE``. See the :manual:`cmake-packages(7)` manual for details on the system package registry. |