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_PROGRAM_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_PROGRAM_PATH.rst')
| -rw-r--r-- | Help/variable/CMAKE_PROGRAM_PATH.rst | 9 |
1 files changed, 3 insertions, 6 deletions
diff --git a/Help/variable/CMAKE_PROGRAM_PATH.rst b/Help/variable/CMAKE_PROGRAM_PATH.rst index 02c5e02..799e119 100644 --- a/Help/variable/CMAKE_PROGRAM_PATH.rst +++ b/Help/variable/CMAKE_PROGRAM_PATH.rst @@ -1,10 +1,7 @@ CMAKE_PROGRAM_PATH ------------------ -Path used for searching by FIND_PROGRAM(). - -Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() -will check each of the contained directories for the existence of the -program which is currently searched. By default it is empty, it is +:ref:`;-list <CMake Language Lists>` of directories specifying a search path +for the :command:`find_program` command. By default it is empty, it is intended to be set by the project. See also -CMAKE_SYSTEM_PROGRAM_PATH, CMAKE_PREFIX_PATH. +:variable:`CMAKE_SYSTEM_PROGRAM_PATH` and :variable:`CMAKE_PREFIX_PATH`. |