diff options
| author | Alex Neundorf <neundorf@kde.org> | 2012-03-10 15:07:07 (GMT) |
|---|---|---|
| committer | Alex Neundorf <neundorf@kde.org> | 2012-03-10 15:09:17 (GMT) |
| commit | 1c69cd8febb41c45d4269d6fef24277a60ed3733 (patch) | |
| tree | aa164ee10d11fff66c48b926440cd98c761c71b0 /Modules/CMakePackageConfigHelpers.cmake | |
| parent | 71c16e457c795bc6635515f026c5f9f8d952b59d (diff) | |
| download | CMake-1c69cd8febb41c45d4269d6fef24277a60ed3733.zip CMake-1c69cd8febb41c45d4269d6fef24277a60ed3733.tar.gz CMake-1c69cd8febb41c45d4269d6fef24277a60ed3733.tar.bz2 | |
write_basic_package_version_file(): improve documentation
add notes when which mode should be used
Alex
Diffstat (limited to 'Modules/CMakePackageConfigHelpers.cmake')
| -rw-r--r-- | Modules/CMakePackageConfigHelpers.cmake | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Modules/CMakePackageConfigHelpers.cmake b/Modules/CMakePackageConfigHelpers.cmake index b174e98..4b1eba4 100644 --- a/Modules/CMakePackageConfigHelpers.cmake +++ b/Modules/CMakePackageConfigHelpers.cmake @@ -69,9 +69,13 @@ # major.minor.patch is the version number of the project to be installed # The COMPATIBILITY mode AnyNewerVersion means that the installed package version # will be considered compatible if it is newer or exactly the same as the requested version. +# This mode should be used for packages which are fully backward compatible, +# also across major versions. # If SameMajorVersion is used instead, then the behaviour differs from AnyNewerVersion # in that the major version number must be the same as requested, e.g. version 2.0 will # not be considered compatible if 1.0 is requested. +# This mode should be used for packages which guarantee backward compatibility within the +# same major version. # If your project has more elaborated version matching rules, you will need to write your # own custom ConfigVersion.cmake file instead of using this macro. # |