mirror of
https://github.com/reactos/CMake.git
synced 2024-11-25 04:29:52 +00:00
Improve documentation for WriteBasicConfigVersionFile.cmake
Alex
This commit is contained in:
parent
208bb9009b
commit
c9761de7ad
@ -1,5 +1,4 @@
|
||||
# This is a basic file for the new style find_package() search mode,
|
||||
# i.e. Config-mode.
|
||||
# This is a basic version file for the Config-mode of find_package().
|
||||
# It is used by WriteBasicConfigVersionFile.cmake as input file for configure_file()
|
||||
# to create a version-file which can be installed along a config.cmake file.
|
||||
#
|
||||
|
@ -1,5 +1,4 @@
|
||||
# This is a basic file for the new style find_package() search mode,
|
||||
# i.e. Config-mode.
|
||||
# This is a basic version file for the Config-mode of find_package().
|
||||
# It is used by WriteBasicConfigVersionFile.cmake as input file for configure_file()
|
||||
# to create a version-file which can be installed along a config.cmake file.
|
||||
#
|
||||
|
@ -5,23 +5,27 @@
|
||||
# filename is the output filename, it should be in the build tree.
|
||||
# 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 suitable if it is newer or exactly the same as the requested version.
|
||||
# will be considered compatible if it is newer or exactly the same as the requested version.
|
||||
# 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 suitable to 1.0 is requested.
|
||||
# If you project has more elaborated version matching rules, you will need to write your
|
||||
# own custom ConfigVersion.cmake file, instead of using this macro.
|
||||
# not be considered compatible if 1.0 is requested.
|
||||
# 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.
|
||||
#
|
||||
# Example:
|
||||
# write_basic_config_version_file(${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake
|
||||
# VERSION 1.2.3
|
||||
# COMPATIBILITY SameMajorVersion )
|
||||
# install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake
|
||||
# ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake
|
||||
# DESTINATION lib/cmake/Foo )
|
||||
#
|
||||
# Internally, this macro executes configure_file() on the input file
|
||||
# Modules/BasicConfigVersion-AnyNewerVersion/SameMajorVersion.cmake.in to
|
||||
# create the resulting version file.
|
||||
# Internally, this macro executes configure_file() to create the resulting
|
||||
# version file. Depending on the COMPATIBLITY, either the file
|
||||
# BasicConfigVersion-SameMajorVersion.cmake.in or BasicConfigVersion-AnyNewerVersion.cmake.in
|
||||
# is used. Please note that these two files are internal to CMake and you should
|
||||
# not call configure_file() on them yourself, but they can be used as starting
|
||||
# point to create more sophisticted custom ConfigVersion.cmake files.
|
||||
|
||||
#=============================================================================
|
||||
# Copyright 2008-2011 Alexander Neundorf, <neundorf@kde.org>
|
||||
|
Loading…
Reference in New Issue
Block a user