summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorfriendlyanon <friendlyanon_@hotmail.com>2022-05-11 17:40:38 (GMT)
committerBrad King <brad.king@kitware.com>2022-05-11 18:00:38 (GMT)
commita82163839a97bbc93d1f4082e99082abbe94a797 (patch)
tree08284619aa42df69280cb7472d27084129e35958
parentcc207014cfb12f9eb9dc3623fa42dc8478dee6b6 (diff)
downloadCMake-a82163839a97bbc93d1f4082e99082abbe94a797.zip
CMake-a82163839a97bbc93d1f4082e99082abbe94a797.tar.gz
CMake-a82163839a97bbc93d1f4082e99082abbe94a797.tar.bz2
CMakePackageConfigHelpers: Fix note about version files supporting ranges
In commit 55c3b6a77e (CMakePackageConfigHelpers: Relax restrictions on version range, 2019-05-30, v3.20.0-rc1~295^2~1) the documentation for write_basic_package_version_file documented the support of version ranges by the generated version files, however the note wrongly specifies a COMPATIBILITY_MODE argument, instead of COMPATIBILITY.
-rw-r--r--Modules/CMakePackageConfigHelpers.cmake6
1 files changed, 3 insertions, 3 deletions
diff --git a/Modules/CMakePackageConfigHelpers.cmake b/Modules/CMakePackageConfigHelpers.cmake
index 5813956..6f5702a 100644
--- a/Modules/CMakePackageConfigHelpers.cmake
+++ b/Modules/CMakePackageConfigHelpers.cmake
@@ -177,9 +177,9 @@ macro.
packages with no binaries.
.. versionadded:: 3.19
- ``COMPATIBILITY_MODE`` ``AnyNewerVersion``, ``SameMajorVersion`` and
- ``SameMinorVersion`` handle the version range if any is specified
- (see :command:`find_package` command for the details).
+ The version file generated by ``AnyNewerVersion``, ``SameMajorVersion`` and
+ ``SameMinorVersion`` arguments of ``COMPATIBILITY`` handle the version range
+ if any is specified (see :command:`find_package` command for the details).
``ExactVersion`` mode is incompatible with version ranges and will display an
author warning if one is specified.