summaryrefslogtreecommitdiffstats
path: root/Help/command/export.rst
diff options
context:
space:
mode:
authorDaniele E. Domenichelli <daniele.domenichelli@iit.it>2014-04-02 14:32:54 (GMT)
committerBrad King <brad.king@kitware.com>2014-05-12 13:50:01 (GMT)
commitbe8ae96098c58cf96ed71badba94e7b45f273f3c (patch)
treebeac603dc9dbfe83ec71db2b8aae5bc54ccce8d6 /Help/command/export.rst
parentd09fda5d91e92155ef674dde97a66547cc750e9f (diff)
downloadCMake-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/export.rst')
-rw-r--r--Help/command/export.rst5
1 files changed, 4 insertions, 1 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.