From c584882b260a3f2bac3238d9bfebf107cd5df61b Mon Sep 17 00:00:00 2001 From: Alex Neundorf Date: Sun, 30 Apr 2023 20:19:47 +0200 Subject: Help: change links to point to the env.vars, not to the cmake vars The documentation of the find-commands was pointing to the cmake variables CMAKE_PREFIX_PATH, CMAKE_INCLUDE_PATH etc. also in the section for environment variables. Now they point to the documentation for the respective environment variables. --- Help/command/FIND_XXX.txt | 9 ++++++--- Help/command/find_file.rst | 7 +++++++ Help/command/find_library.rst | 6 ++++++ Help/command/find_package.rst | 4 ++-- Help/command/find_path.rst | 6 ++++++ Help/command/find_program.rst | 5 +++++ 6 files changed, 32 insertions(+), 5 deletions(-) (limited to 'Help') diff --git a/Help/command/FIND_XXX.txt b/Help/command/FIND_XXX.txt index 21236fa427..fe26d2b9a5 100644 --- a/Help/command/FIND_XXX.txt +++ b/Help/command/FIND_XXX.txt @@ -132,6 +132,9 @@ If ``NO_DEFAULT_PATH`` is not specified, the search process is as follows: .. |CMAKE_PREFIX_PATH_XXX_SUBDIR| replace:: |prefix_XXX_SUBDIR| for each ```` in :variable:`CMAKE_PREFIX_PATH` +.. |ENV_CMAKE_PREFIX_PATH_XXX_SUBDIR| replace:: + |prefix_XXX_SUBDIR| for each ```` in :envvar:`CMAKE_PREFIX_PATH` + .. |SYSTEM_ENVIRONMENT_PREFIX_PATH_XXX_SUBDIR| replace:: |prefix_XXX_SUBDIR| for each ``/[s]bin`` in ``PATH``, and |entry_XXX_SUBDIR| for other entries in ``PATH`` @@ -194,9 +197,9 @@ If ``NO_DEFAULT_PATH`` is not specified, the search process is as follows: This can be skipped if ``NO_CMAKE_ENVIRONMENT_PATH`` is passed or by setting the :variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH` to ``FALSE``. - * |CMAKE_PREFIX_PATH_XXX| - * |CMAKE_XXX_PATH| - * |CMAKE_XXX_MAC_PATH| + * |ENV_CMAKE_PREFIX_PATH_XXX| + * |ENV_CMAKE_XXX_PATH| + * |ENV_CMAKE_XXX_MAC_PATH| 4. Search the paths specified by the ``HINTS`` option. These should be paths computed by system introspection, such as a diff --git a/Help/command/find_file.rst b/Help/command/find_file.rst index c5c40149de..9f89f5251d 100644 --- a/Help/command/find_file.rst +++ b/Help/command/find_file.rst @@ -19,6 +19,13 @@ find_file .. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_INCLUDE_PATH` .. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_FRAMEWORK_PATH` +.. |ENV_CMAKE_PREFIX_PATH_XXX| replace:: + ``/include/`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE` is set, + and |ENV_CMAKE_PREFIX_PATH_XXX_SUBDIR| +.. |ENV_CMAKE_XXX_PATH| replace:: :envvar:`CMAKE_INCLUDE_PATH` +.. |ENV_CMAKE_XXX_MAC_PATH| replace:: :envvar:`CMAKE_FRAMEWORK_PATH` + + .. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``INCLUDE`` and ``PATH``. .. |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| replace:: On Windows hosts: diff --git a/Help/command/find_library.rst b/Help/command/find_library.rst index c237e7f0d3..99e36a49b6 100644 --- a/Help/command/find_library.rst +++ b/Help/command/find_library.rst @@ -19,6 +19,12 @@ find_library .. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_LIBRARY_PATH` .. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_FRAMEWORK_PATH` +.. |ENV_CMAKE_PREFIX_PATH_XXX| replace:: + ``/lib/`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE` is set, + and |ENV_CMAKE_PREFIX_PATH_XXX_SUBDIR| +.. |ENV_CMAKE_XXX_PATH| replace:: :envvar:`CMAKE_LIBRARY_PATH` +.. |ENV_CMAKE_XXX_MAC_PATH| replace:: :envvar:`CMAKE_FRAMEWORK_PATH` + .. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``LIB`` and ``PATH``. .. |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| replace:: On Windows hosts: diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index b82088eaa0..b0b6fe1112 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -418,8 +418,8 @@ enabled. * ``_DIR`` * :envvar:`CMAKE_PREFIX_PATH` - * ``CMAKE_FRAMEWORK_PATH`` - * ``CMAKE_APPBUNDLE_PATH`` + * :envvar:`CMAKE_FRAMEWORK_PATH` + * :envvar:`CMAKE_APPBUNDLE_PATH` 4. Search paths specified by the ``HINTS`` option. These should be paths computed by system introspection, such as a hint provided by the diff --git a/Help/command/find_path.rst b/Help/command/find_path.rst index 1d7648d05c..f0522f6430 100644 --- a/Help/command/find_path.rst +++ b/Help/command/find_path.rst @@ -19,6 +19,12 @@ find_path .. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_INCLUDE_PATH` .. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_FRAMEWORK_PATH` +.. |ENV_CMAKE_PREFIX_PATH_XXX| replace:: + ``/include/`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE` is set, + and |ENV_CMAKE_PREFIX_PATH_XXX_SUBDIR| +.. |ENV_CMAKE_XXX_PATH| replace:: :envvar:`CMAKE_INCLUDE_PATH` +.. |ENV_CMAKE_XXX_MAC_PATH| replace:: :envvar:`CMAKE_FRAMEWORK_PATH` + .. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``INCLUDE`` and ``PATH``. .. |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| replace:: On Windows hosts: diff --git a/Help/command/find_program.rst b/Help/command/find_program.rst index f4149be5ad..fe95a9a300 100644 --- a/Help/command/find_program.rst +++ b/Help/command/find_program.rst @@ -17,6 +17,11 @@ find_program .. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_PROGRAM_PATH` .. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_APPBUNDLE_PATH` +.. |ENV_CMAKE_PREFIX_PATH_XXX| replace:: + |ENV_CMAKE_PREFIX_PATH_XXX_SUBDIR| +.. |ENV_CMAKE_XXX_PATH| replace:: :envvar:`CMAKE_PROGRAM_PATH` +.. |ENV_CMAKE_XXX_MAC_PATH| replace:: :envvar:`CMAKE_APPBUNDLE_PATH` + .. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: The directories in ``PATH`` itself. .. |SYSTEM_ENVIRONMENT_PATH_WINDOWS_XXX| replace:: On Windows hosts no extra search paths are included -- cgit v1.2.1