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_PREFIX_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_PREFIX_PATH.rst')
| -rw-r--r-- | Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst b/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst index 537eaba..e74dfad 100644 --- a/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst +++ b/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst @@ -1,16 +1,18 @@ CMAKE_SYSTEM_PREFIX_PATH ------------------------ -Path used for searching by FIND_XXX(), with appropriate suffixes added. +:ref:`;-list <CMake Language Lists>` of directories specifying installation +*prefixes* to be searched by the :command:`find_package`, +:command:`find_program`, :command:`find_library`, :command:`find_file`, and +:command:`find_path` commands. Each command will add appropriate +subdirectories (like ``bin``, ``lib``, or ``include``) as specified in its own +documentation. -Specifies a path which will be used by the FIND_XXX() commands. It -contains the "base" directories, the FIND_XXX() commands append -appropriate subdirectories to the base directories. So FIND_PROGRAM() -adds /bin to each of the directories in the path, FIND_LIBRARY() -appends /lib to each of the directories, and FIND_PATH() and -FIND_FILE() append /include . By default this contains the standard -directories for the current system, the CMAKE_INSTALL_PREFIX and -the :variable:`CMAKE_STAGING_PREFIX`. It is NOT intended to be modified by -the project, use CMAKE_PREFIX_PATH for this. See also CMAKE_SYSTEM_INCLUDE_PATH, -CMAKE_SYSTEM_LIBRARY_PATH, CMAKE_SYSTEM_PROGRAM_PATH, and -CMAKE_SYSTEM_IGNORE_PATH. +By default this contains the standard directories for the current system, the +:variable:`CMAKE_INSTALL_PREFIX`, and the :variable:`CMAKE_STAGING_PREFIX`. +It is *not* intended to be modified by the project; use +:variable:`CMAKE_PREFIX_PATH` for this. + +See also :variable:`CMAKE_SYSTEM_INCLUDE_PATH`, +:variable:`CMAKE_SYSTEM_LIBRARY_PATH`, :variable:`CMAKE_SYSTEM_PROGRAM_PATH`, +and :variable:`CMAKE_SYSTEM_IGNORE_PATH`. |