summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake-packages.7.rst
diff options
context:
space:
mode:
authorRobert Maynard <robert.maynard@kitware.com>2018-11-13 14:39:27 (GMT)
committerRobert Maynard <robert.maynard@kitware.com>2019-07-09 13:38:35 (GMT)
commit1d00ba9ccf62087016e41f237dbae7f94d3aa1f6 (patch)
tree74cf5845442a8c97f56e96c21d34851c696ff8c7 /Help/manual/cmake-packages.7.rst
parent704e3a2ca89a3ea75b3cf55efe9bd5d6826168da (diff)
downloadCMake-1d00ba9ccf62087016e41f237dbae7f94d3aa1f6.zip
CMake-1d00ba9ccf62087016e41f237dbae7f94d3aa1f6.tar.gz
CMake-1d00ba9ccf62087016e41f237dbae7f94d3aa1f6.tar.bz2
Find: find_package prefers variable CMAKE_FIND_USE_REGISTRY
CMake's find control flags should all have a consistent name. To make this happen we are introducing `CMAKE_FIND_USE_REGISTRY` and deprecating `CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY`.
Diffstat (limited to 'Help/manual/cmake-packages.7.rst')
-rw-r--r--Help/manual/cmake-packages.7.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/Help/manual/cmake-packages.7.rst b/Help/manual/cmake-packages.7.rst
index f5aa42d..4b2934a 100644
--- a/Help/manual/cmake-packages.7.rst
+++ b/Help/manual/cmake-packages.7.rst
@@ -654,8 +654,13 @@ allows one to disable them using the following variables:
:command:`export(PACKAGE)` populates the user package registry unless
the :variable:`CMAKE_EXPORT_NO_PACKAGE_REGISTRY` variable explicitly
disables it.
-* :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` disables the
- User Package Registry in all the :command:`find_package` calls.
+* :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` disables the
+ User Package Registry in all the :command:`find_package` calls when
+ set to ``FALSE``.
+* Deprecated :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` disables the
+ User Package Registry in all the :command:`find_package` calls when set
+ to ``TRUE``. This variable is ignored when
+ :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` has been set.
* :variable:`CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY` disables
the System Package Registry in all the :command:`find_package` calls.