summaryrefslogtreecommitdiffstats
path: root/Help/policy
diff options
context:
space:
mode:
authorBartosz Kosiorek <bartosz.kosiorek@tomtom.com>2019-04-01 13:14:27 (GMT)
committerBartosz Kosiorek <bartosz.kosiorek@tomtom.com>2019-04-04 13:13:58 (GMT)
commit456e0fb64f5c70191145c34104d6f25bd24b7b37 (patch)
treef728b6b9ea236c5d0bb84ba91a9e5dd7a04471bc /Help/policy
parent5ad73b608d4fc7cc6b30017159b800802a503b0c (diff)
downloadCMake-456e0fb64f5c70191145c34104d6f25bd24b7b37.zip
CMake-456e0fb64f5c70191145c34104d6f25bd24b7b37.tar.gz
CMake-456e0fb64f5c70191145c34104d6f25bd24b7b37.tar.bz2
Help: Improve documentation formating
Diffstat (limited to 'Help/policy')
-rw-r--r--Help/policy/CMP0008.rst5
-rw-r--r--Help/policy/CMP0014.rst8
-rw-r--r--Help/policy/CMP0015.rst14
-rw-r--r--Help/policy/CMP0017.rst4
-rw-r--r--Help/policy/CMP0037.rst5
5 files changed, 19 insertions, 17 deletions
diff --git a/Help/policy/CMP0008.rst b/Help/policy/CMP0008.rst
index 654a90f..18ede82 100644
--- a/Help/policy/CMP0008.rst
+++ b/Help/policy/CMP0008.rst
@@ -12,11 +12,12 @@ In CMake 2.4 and below it is possible to write code like
where ``somelib`` is supposed to be a valid library file name such as
``libsomelib.a`` or ``somelib.lib``. For Makefile generators this
produces an error at build time because the dependency on the full
-path cannot be found. For VS IDE and Xcode generators this used to
+path cannot be found. For :ref:`Visual Studio Generators` IDE
+and :generator:`Xcode` generators this used to
work by accident because CMake would always split off the library
directory and ask the linker to search for the library by name
(``-lsomelib`` or ``somelib.lib``). Despite the failure with Makefiles, some
-projects have code like this and build only with VS and/or Xcode.
+projects have code like this and build only with Visual Studio and/or Xcode.
This version of CMake prefers to pass the full path directly to the
native build tool, which will fail in this case because it does not
name a valid library file.
diff --git a/Help/policy/CMP0014.rst b/Help/policy/CMP0014.rst
index 5d7add2..331dde5 100644
--- a/Help/policy/CMP0014.rst
+++ b/Help/policy/CMP0014.rst
@@ -4,11 +4,11 @@ CMP0014
Input directories must have ``CMakeLists.txt``.
CMake versions before 2.8 silently ignored missing ``CMakeLists.txt``
-files in directories referenced by add_subdirectory() or subdirs(),
+files in directories referenced by :command:`add_subdirectory` or :command:`subdirs`,
treating them as if present but empty. In CMake 2.8.0 and above this
-policy determines whether or not the case is an error. The ``OLD``
-behavior for this policy is to silently ignore the problem. The ``NEW``
-behavior for this policy is to report an error.
+:command:`cmake_policy` determines whether or not the case is an error.
+The ``OLD`` behavior for this policy is to silently ignore the problem.
+The ``NEW`` behavior for this policy is to report an error.
This policy was introduced in CMake version 2.8.0. CMake version
|release| warns when the policy is not set and uses ``OLD`` behavior. Use
diff --git a/Help/policy/CMP0015.rst b/Help/policy/CMP0015.rst
index b90c679..90d5203 100644
--- a/Help/policy/CMP0015.rst
+++ b/Help/policy/CMP0015.rst
@@ -1,16 +1,16 @@
CMP0015
-------
-link_directories() treats paths relative to the source dir.
+ :command:`link_directories` treats paths relative to the source dir.
-In CMake 2.8.0 and lower the link_directories() command passed
+In CMake 2.8.0 and lower the :command:`link_directories` command passed
relative paths unchanged to the linker. In CMake 2.8.1 and above the
-link_directories() command prefers to interpret relative paths with
-respect to CMAKE_CURRENT_SOURCE_DIR, which is consistent with
-include_directories() and other commands. The ``OLD`` behavior for this
-policy is to use relative paths verbatim in the linker command. The
+:command:`link_directories` command prefers to interpret relative paths with
+respect to ``CMAKE_CURRENT_SOURCE_DIR``, which is consistent with
+:command:`include_directories` and other commands. The ``OLD`` behavior for
+this policy is to use relative paths verbatim in the linker command. The
``NEW`` behavior for this policy is to convert relative paths to absolute
-paths by appending the relative path to CMAKE_CURRENT_SOURCE_DIR.
+paths by appending the relative path to ``CMAKE_CURRENT_SOURCE_DIR``.
This policy was introduced in CMake version 2.8.1. CMake version
|release| warns when the policy is not set and uses ``OLD`` behavior. Use
diff --git a/Help/policy/CMP0017.rst b/Help/policy/CMP0017.rst
index 99bd090..ca4664e 100644
--- a/Help/policy/CMP0017.rst
+++ b/Help/policy/CMP0017.rst
@@ -5,12 +5,12 @@ 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 :command:`include` or
-find_package(), the files located in the CMake module directory are
+:command:`find_package`, the files located in the CMake module directory are
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 :variable:`CMAKE_MODULE_PATH` still take
-precedence over the ones in the CMake module directory. The OLD
+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.
diff --git a/Help/policy/CMP0037.rst b/Help/policy/CMP0037.rst
index c028b41..9895fb0 100644
--- a/Help/policy/CMP0037.rst
+++ b/Help/policy/CMP0037.rst
@@ -10,8 +10,9 @@ as :manual:`cmake-generator-expressions(7)` and some
diagnostics expect target names to match a restricted pattern.
Target names may contain upper and lower case letters, numbers, the underscore
-character (_), dot(.), plus(+) and minus(-). As a special case, ALIAS
-targets and ``IMPORTED`` targets may contain two consecutive colons.
+character (``_``), dot(``.``), plus(``+``) and minus(``-``).
+As a special case, ``ALIAS`` and ``IMPORTED`` targets may contain
+two consecutive colons.
Target names reserved by one or more CMake generators are not allowed.
Among others these include ``all``, ``clean``, ``help``, and ``install``.