diff options
author | Brad King <brad.king@kitware.com> | 2015-06-25 14:04:42 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2015-06-25 14:05:23 (GMT) |
commit | 3117b5feecf94914361e3683f1206f2d9d724c89 (patch) | |
tree | 2d087e4e00d20072cef160a92115ec6a2d1c9fcc /Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst | |
parent | a6916a6c6e397bda8b381f65dbfc59d3c52f8525 (diff) | |
download | CMake-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_SYSTEM_INCLUDE_PATH.rst')
-rw-r--r-- | Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst | 13 |
1 files changed, 5 insertions, 8 deletions
diff --git a/Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst b/Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst index 1734185..2c14345 100644 --- a/Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst +++ b/Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst @@ -1,11 +1,8 @@ CMAKE_SYSTEM_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 contains the standard directories for the current -system. It is NOT intended to be modified by the project, use -CMAKE_INCLUDE_PATH for this. See also CMAKE_SYSTEM_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 +this contains the standard directories for the current system. It is *not* +intended to be modified by the project; use :variable:`CMAKE_INCLUDE_PATH` for +this. See also :variable:`CMAKE_SYSTEM_PREFIX_PATH`. |