summaryrefslogtreecommitdiff
path: root/Help/policy/CMP0017.rst
diff options
context:
space:
mode:
authorBartosz Kosiorek <bartosz.kosiorek@tomtom.com>2019-03-26 16:13:41 +0100
committerBartosz Kosiorek <bartosz.kosiorek@tomtom.com>2019-03-27 16:01:20 +0100
commit07f3082d3b52f1bcba8dd4ef82b3e02c362b392e (patch)
tree36eb4256e37351a30273b3852c2d799c0e2e2e03 /Help/policy/CMP0017.rst
parentdb20cb2f9f2ff1d00593e0fc921184d99f58749a (diff)
downloadcmake-07f3082d3b52f1bcba8dd4ef82b3e02c362b392e.tar.gz
Help: Improve documentation links and formatting
Diffstat (limited to 'Help/policy/CMP0017.rst')
-rw-r--r--Help/policy/CMP0017.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Help/policy/CMP0017.rst b/Help/policy/CMP0017.rst
index 9f0f0380f5..99bd090d7d 100644
--- a/Help/policy/CMP0017.rst
+++ b/Help/policy/CMP0017.rst
@@ -4,18 +4,18 @@ CMP0017
Prefer files from the CMake module directory when including from there.
Starting with CMake 2.8.4, if a cmake-module shipped with CMake (i.e.
-located in the CMake module directory) calls include() or
+located in the CMake module directory) calls :command:`include` or
find_package(), the files located in the CMake module directory are
-preferred over the files in CMAKE_MODULE_PATH. This makes sure that
-the modules belonging to CMake always get those files included which
+preferred over the files in :variable:`CMAKE_MODULE_PATH`. This makes sure
+that the modules belonging to CMake always get those files included which
they expect, and against which they were developed and tested. In all
-other cases, the files found in CMAKE_MODULE_PATH still take
+other cases, the files found in :variable:`CMAKE_MODULE_PATH` still take
precedence over the ones in the CMake module directory. The OLD
behavior is to always prefer files from CMAKE_MODULE_PATH over files
from the CMake modules directory.
This policy was introduced in CMake version 2.8.4. 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.
+|release| warns when the policy is not set and uses ``OLD`` behavior. Use
+the :command:`cmake_policy` command to set it to ``OLD`` or ``NEW`` explicitly.
.. include:: DEPRECATED.txt