diff options
Diffstat (limited to 'modules/ECMSetupVersion.cmake')
| -rw-r--r-- | modules/ECMSetupVersion.cmake | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/modules/ECMSetupVersion.cmake b/modules/ECMSetupVersion.cmake index 73b71ed1..330f7365 100644 --- a/modules/ECMSetupVersion.cmake +++ b/modules/ECMSetupVersion.cmake @@ -36,7 +36,7 @@ version of ECM is < 5.83):: <prefix>_VERSION_STRING - <version> (use <prefix>_VERSION instead) -If CMake policy CMP0048 is not NEW, the following CMake variables will also +If CMake policy CMP0048 is not ``NEW``, the following CMake variables will also be set:: PROJECT_VERSION_MAJOR - <major> @@ -44,14 +44,14 @@ be set:: PROJECT_VERSION_PATCH - <patch> PROJECT_VERSION - <version> -For backward-compatibility, if CMake policy CMP0048 is not NEW, also this variable is set +For backward-compatibility, if CMake policy CMP0048 is not ``NEW``, also this variable is set (only if the minimum required version of ECM is < 5.83):: PROJECT_VERSION_STRING - <version> (use PROJECT_VERSION instead) -If the VERSION_HEADER option is used, a simple C header is generated with the +If the ``VERSION_HEADER`` option is used, a simple C header is generated with the given filename. If filename is a relative path, it is interpreted as relative -to CMAKE_CURRENT_BINARY_DIR. The generated header contains the following +to ``CMAKE_CURRENT_BINARY_DIR``. The generated header contains the following macros:: <prefix>_VERSION_MAJOR - <major> as an integer @@ -64,15 +64,15 @@ macros:: next 8 bits and ``<major>`` in the remaining bits. Note that ``<patch>`` and ``<minor>`` must be less than 256. -If the PACKAGE_VERSION_FILE option is used, a simple CMake package version -file is created using the write_basic_package_version_file() macro provided by +If the ``PACKAGE_VERSION_FILE`` option is used, a simple CMake package version +file is created using the ``write_basic_package_version_file()`` macro provided by CMake. It should be installed in the same location as the Config.cmake file of -the library so that it can be found by find_package(). If the filename is a -relative path, it is interpreted as relative to CMAKE_CURRENT_BINARY_DIR. The -optional COMPATIBILITY option is forwarded to -write_basic_package_version_file(), and defaults to AnyNewerVersion. +the library so that it can be found by ``find_package()``. If the filename is a +relative path, it is interpreted as relative to ``CMAKE_CURRENT_BINARY_DIR``. The +optional ``COMPATIBILITY`` option is forwarded to +``write_basic_package_version_file()``, and defaults to ``AnyNewerVersion``. -If CMake policy CMP0048 is NEW, an alternative form of the command is +If CMake policy CMP0048 is ``NEW``, an alternative form of the command is available:: ecm_setup_version(PROJECT @@ -81,14 +81,14 @@ available:: [VERSION_HEADER <filename>] [PACKAGE_VERSION_FILE <filename>] ) -This will use the version information set by the project() command. -VARIABLE_PREFIX defaults to the project name. Note that PROJECT must be the +This will use the version information set by the ``project()`` command. +``VARIABLE_PREFIX`` defaults to the project name. Note that ``PROJECT`` must be the first argument. In all other respects, it behaves like the other form of the command. Since pre-1.0.0. -COMPATIBILITY option available since 1.6.0. +``COMPATIBILITY`` option available since 1.6.0. #]=======================================================================] include(CMakePackageConfigHelpers) |