diff options
| author | Brad King <brad.king@kitware.com> | 2021-02-04 09:05:58 -0500 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2021-02-04 09:09:25 -0500 |
| commit | c40e81ce8023f4b21860ae94adeddcf78ed2f935 (patch) | |
| tree | d34d4bb5dc5257cce2981f066e7e3ab2ff0b7590 /Help | |
| parent | c131afc190d69f605c83391d12dde142f481a698 (diff) | |
| download | cmake-c40e81ce8023f4b21860ae94adeddcf78ed2f935.tar.gz | |
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')
| -rw-r--r-- | Help/command/find_file.rst | 3 | ||||
| -rw-r--r-- | Help/command/find_library.rst | 3 | ||||
| -rw-r--r-- | Help/command/find_path.rst | 3 |
3 files changed, 6 insertions, 3 deletions
diff --git a/Help/command/find_file.rst b/Help/command/find_file.rst index 3f03f37e37..39dfb85828 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 8a55aca3db..ab957ce9be 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 52ffe3c795..ec66771076 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|. |