summaryrefslogtreecommitdiffstats
path: root/Help/variable/CMAKE_INCLUDE_PATH.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-06-25 14:04:42 (GMT)
committerBrad King <brad.king@kitware.com>2015-06-25 14:05:23 (GMT)
commit3117b5feecf94914361e3683f1206f2d9d724c89 (patch)
tree2d087e4e00d20072cef160a92115ec6a2d1c9fcc /Help/variable/CMAKE_INCLUDE_PATH.rst
parenta6916a6c6e397bda8b381f65dbfc59d3c52f8525 (diff)
downloadCMake-3117b5feecf94914361e3683f1206f2d9d724c89.zip
CMake-3117b5feecf94914361e3683f1206f2d9d724c89.tar.gz
CMake-3117b5feecf94914361e3683f1206f2d9d724c89.tar.bz2
Help: Revise CMAKE_*_PATH and CMAKE_SYSTEM_*_PATH variable docs (#15631)
Improve reStructuredText formatting and cross-references. Specify explicitly that each variable may be set to a ;-list of multiple values.
Diffstat (limited to 'Help/variable/CMAKE_INCLUDE_PATH.rst')
-rw-r--r--Help/variable/CMAKE_INCLUDE_PATH.rst11
1 files changed, 4 insertions, 7 deletions
diff --git a/Help/variable/CMAKE_INCLUDE_PATH.rst b/Help/variable/CMAKE_INCLUDE_PATH.rst
index 360b403..e4e7f2c 100644
--- a/Help/variable/CMAKE_INCLUDE_PATH.rst
+++ b/Help/variable/CMAKE_INCLUDE_PATH.rst
@@ -1,10 +1,7 @@
CMAKE_INCLUDE_PATH
------------------
-Path used for searching by FIND_FILE() and FIND_PATH().
-
-Specifies a path which will be used both by FIND_FILE() and
-FIND_PATH(). Both commands will check each of the contained
-directories for the existence of the file which is currently searched.
-By default it is empty, it is intended to be set by the project. See
-also CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_PREFIX_PATH.
+:ref:`;-list <CMake Language Lists>` of directories specifying a search path
+for the :command:`find_file` and :command:`find_path` commands. By default it
+is empty, it is intended to be set by the project. See also
+:variable:`CMAKE_SYSTEM_INCLUDE_PATH` and :variable:`CMAKE_PREFIX_PATH`.