summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-03-15 14:45:39 (GMT)
committerKitware Robot <kwrobot@kitware.com>2019-03-15 14:45:51 (GMT)
commit3261f2387038e251d25852069f0ffc6fb81ed0a0 (patch)
treecad862584e7da75467d5ec0070b3dc5c55980e6f /Help/command
parenta6d8165dd2abe81dd133d188c8fe81323944c469 (diff)
parent9bede5c4cecd71fba7ce6a0687c4a68e1c84a54b (diff)
downloadCMake-3261f2387038e251d25852069f0ffc6fb81ed0a0.zip
CMake-3261f2387038e251d25852069f0ffc6fb81ed0a0.tar.gz
CMake-3261f2387038e251d25852069f0ffc6fb81ed0a0.tar.bz2
Merge topic 'export-package-default-off'
9bede5c4ce export: Disable PACKAGE mode user package registry by default Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Lukas Mosimann <lumosimann@gmail.com> Merge-request: !3041
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/export.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/Help/command/export.rst b/Help/command/export.rst
index b255ee8..ffd60e1 100644
--- a/Help/command/export.rst
+++ b/Help/command/export.rst
@@ -62,8 +62,13 @@ registry that this command creates works only in conjunction with a
package configuration file (``<PackageName>Config.cmake``) that works with the
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.
+registry.
+
+By default the ``export(PACKAGE)`` command does nothing (see policy
+:policy:`CMP0090`) because populating the user package registry has effects
+outside the source and build trees. Set the
+:variable:`CMAKE_EXPORT_PACKAGE_REGISTRY` variable to add build directories to
+the CMake user package registry.
.. code-block:: cmake