summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2021-02-04 14:05:58 (GMT)
committerBrad King <brad.king@kitware.com>2021-02-04 14:09:25 (GMT)
commitc40e81ce8023f4b21860ae94adeddcf78ed2f935 (patch)
treed34d4bb5dc5257cce2981f066e7e3ab2ff0b7590 /Help/command
parentc131afc190d69f605c83391d12dde142f481a698 (diff)
downloadCMake-c40e81ce8023f4b21860ae94adeddcf78ed2f935.zip
CMake-c40e81ce8023f4b21860ae94adeddcf78ed2f935.tar.gz
CMake-c40e81ce8023f4b21860ae94adeddcf78ed2f935.tar.bz2
Help: Restore docs that find_library considers LIB, not INCLUDE
Documentation updates in commit 02f527c66a (Find: Provide global controls for the `NO_[]_PATH` call options, 2019-06-12, v3.16.0-rc1~541^2) accidentally switched the `find_library` documentation to mention `INCLUDE` where it should be `LIB`. While at it, update `find_file` and `find_path` to mention `INCLUDE` and `PATH` in the order they are considered.
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/find_file.rst3
-rw-r--r--Help/command/find_library.rst3
-rw-r--r--Help/command/find_path.rst3
3 files changed, 6 insertions, 3 deletions
diff --git a/Help/command/find_file.rst b/Help/command/find_file.rst
index 3f03f37..39dfb85 100644
--- a/Help/command/find_file.rst
+++ b/Help/command/find_file.rst
@@ -17,7 +17,8 @@ find_file
.. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_INCLUDE_PATH`
.. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_FRAMEWORK_PATH`
-.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``PATH`` and ``INCLUDE``.
+.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``INCLUDE``
+ and ``PATH``.
.. |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| replace:: On Windows hosts:
``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
is set, and |SYSTEM_ENVIRONMENT_PREFIX_PATH_XXX_SUBDIR|.
diff --git a/Help/command/find_library.rst b/Help/command/find_library.rst
index 8a55aca..ab957ce 100644
--- a/Help/command/find_library.rst
+++ b/Help/command/find_library.rst
@@ -17,7 +17,8 @@ find_library
.. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_LIBRARY_PATH`
.. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_FRAMEWORK_PATH`
-.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``PATH`` and ``INCLUDE``.
+.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``LIB``
+ and ``PATH``.
.. |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| replace:: On Windows hosts:
``<prefix>/lib/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
is set, and |SYSTEM_ENVIRONMENT_PREFIX_PATH_XXX_SUBDIR|.
diff --git a/Help/command/find_path.rst b/Help/command/find_path.rst
index 52ffe3c..ec66771 100644
--- a/Help/command/find_path.rst
+++ b/Help/command/find_path.rst
@@ -17,7 +17,8 @@ find_path
.. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_INCLUDE_PATH`
.. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_FRAMEWORK_PATH`
-.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``PATH`` and ``INCLUDE``.
+.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``INCLUDE``
+ and ``PATH``.
.. |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| replace:: On Windows hosts:
``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
is set, and |SYSTEM_ENVIRONMENT_PREFIX_PATH_XXX_SUBDIR|.