diff options
author | Robert Maynard <robert.maynard@kitware.com> | 2018-11-13 14:39:27 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2019-03-15 14:24:47 (GMT) |
commit | 9bede5c4cecd71fba7ce6a0687c4a68e1c84a54b (patch) | |
tree | 57e94c1e43b25ea3706b55cccff48d57b25dfc6d /Help/command | |
parent | 0df31d99ae44e1e151feb4df977a4332833ea872 (diff) | |
download | CMake-9bede5c4cecd71fba7ce6a0687c4a68e1c84a54b.zip CMake-9bede5c4cecd71fba7ce6a0687c4a68e1c84a54b.tar.gz CMake-9bede5c4cecd71fba7ce6a0687c4a68e1c84a54b.tar.bz2 |
export: Disable PACKAGE mode user package registry by default
The user package registry populated by the `export()` command causes
side effects outside the build and source directories. Such effects
should be opt-in rather than op-out. Introduce a policy to change
default behavior of `export(PACKAGE)` to do nothing.
Diffstat (limited to 'Help/command')
-rw-r--r-- | Help/command/export.rst | 9 |
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 |