diff options
author | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-03-26 15:13:41 (GMT) |
---|---|---|
committer | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-03-27 15:01:20 (GMT) |
commit | 07f3082d3b52f1bcba8dd4ef82b3e02c362b392e (patch) | |
tree | 36eb4256e37351a30273b3852c2d799c0e2e2e03 /Help/policy/CMP0048.rst | |
parent | db20cb2f9f2ff1d00593e0fc921184d99f58749a (diff) | |
download | CMake-07f3082d3b52f1bcba8dd4ef82b3e02c362b392e.zip CMake-07f3082d3b52f1bcba8dd4ef82b3e02c362b392e.tar.gz CMake-07f3082d3b52f1bcba8dd4ef82b3e02c362b392e.tar.bz2 |
Help: Improve documentation links and formatting
Diffstat (limited to 'Help/policy/CMP0048.rst')
-rw-r--r-- | Help/policy/CMP0048.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/Help/policy/CMP0048.rst b/Help/policy/CMP0048.rst index 0e7e606..e63ec01 100644 --- a/Help/policy/CMP0048.rst +++ b/Help/policy/CMP0048.rst @@ -1,24 +1,24 @@ CMP0048 ------- -The :command:`project` command manages VERSION variables. +The :command:`project` command manages ``VERSION`` variables. CMake version 3.0 introduced the ``VERSION`` option of the :command:`project` command to specify a project version as well as the name. In order to keep :variable:`PROJECT_VERSION` and related variables consistent with variable -:variable:`PROJECT_NAME` it is necessary to set the VERSION variables +:variable:`PROJECT_NAME` it is necessary to set the ``VERSION`` variables to the empty string when no ``VERSION`` is given to :command:`project`. -However, this can change behavior for existing projects that set VERSION +However, this can change behavior for existing projects that set ``VERSION`` variables themselves since :command:`project` may now clear them. This policy controls the behavior for compatibility with such projects. -The OLD behavior for this policy is to leave VERSION variables untouched. -The NEW behavior for this policy is to set VERSION as documented by the +The ``OLD`` behavior for this policy is to leave ``VERSION`` variables untouched. +The ``NEW`` behavior for this policy is to set ``VERSION`` as documented by the :command:`project` command. This policy was introduced in CMake version 3.0. CMake version |release| warns when the policy is not set and uses -OLD behavior. Use the cmake_policy command to set it to OLD or -NEW explicitly. +``OLD`` behavior. Use the :command:`cmake_policy` command to set +it to ``OLD`` or ``NEW`` explicitly. .. include:: DEPRECATED.txt |