From e40d4eb64465acd70004851928e07caa55bf46dd Mon Sep 17 00:00:00 2001 From: Alex Neundorf Date: Sun, 30 Apr 2023 19:22:24 +0200 Subject: Help: add documentation for some CMAKE_XXX_PATH env.vars This patch adds basic documentation for the CMAKE_INCLUDE_PATH, CMAKE_LIBRARY_PATH, CMAKE_PROGRAM_PATH, CMAKE_APPBUNDLE_PATH and CMAKE_FRAMEWORK_PATH environment variables and links to the respective cmake variables and vice versa. --- Help/envvar/CMAKE_APPBUNDLE_PATH.rst | 14 ++++++++++++++ Help/envvar/CMAKE_FRAMEWORK_PATH.rst | 15 +++++++++++++++ Help/envvar/CMAKE_INCLUDE_PATH.rst | 13 +++++++++++++ Help/envvar/CMAKE_LIBRARY_PATH.rst | 13 +++++++++++++ Help/envvar/CMAKE_PROGRAM_PATH.rst | 13 +++++++++++++ Help/manual/cmake-env-variables.7.rst | 5 +++++ Help/variable/CMAKE_APPBUNDLE_PATH.rst | 3 +++ Help/variable/CMAKE_FRAMEWORK_PATH.rst | 3 +++ Help/variable/CMAKE_INCLUDE_PATH.rst | 9 +++++++-- Help/variable/CMAKE_LIBRARY_PATH.rst | 8 ++++++-- Help/variable/CMAKE_PREFIX_PATH.rst | 2 +- Help/variable/CMAKE_PROGRAM_PATH.rst | 8 ++++++-- 12 files changed, 99 insertions(+), 7 deletions(-) create mode 100644 Help/envvar/CMAKE_APPBUNDLE_PATH.rst create mode 100644 Help/envvar/CMAKE_FRAMEWORK_PATH.rst create mode 100644 Help/envvar/CMAKE_INCLUDE_PATH.rst create mode 100644 Help/envvar/CMAKE_LIBRARY_PATH.rst create mode 100644 Help/envvar/CMAKE_PROGRAM_PATH.rst (limited to 'Help') diff --git a/Help/envvar/CMAKE_APPBUNDLE_PATH.rst b/Help/envvar/CMAKE_APPBUNDLE_PATH.rst new file mode 100644 index 0000000000..d80e08dcf7 --- /dev/null +++ b/Help/envvar/CMAKE_APPBUNDLE_PATH.rst @@ -0,0 +1,14 @@ +CMAKE_APPBUNDLE_PATH +-------------------- + +.. include:: ENV_VAR.txt + +The ``CMAKE_APPBUNDLE_PATH`` environment variable may be set to a list of +directories to be searched for macOS application bundles +by the :command:`find_program` and :command:`find_package` commands. + +This variable may hold a single directory or a list of directories separated +by ``:`` on UNIX or ``;`` on Windows (the same as the ``PATH`` environment +variable convention on those platforms). + +See also the :variable:`CMAKE_APPBUNDLE_PATH` CMake variable. diff --git a/Help/envvar/CMAKE_FRAMEWORK_PATH.rst b/Help/envvar/CMAKE_FRAMEWORK_PATH.rst new file mode 100644 index 0000000000..f543132dbc --- /dev/null +++ b/Help/envvar/CMAKE_FRAMEWORK_PATH.rst @@ -0,0 +1,15 @@ +CMAKE_FRAMEWORK_PATH +-------------------- + +.. include:: ENV_VAR.txt + +The ``CMAKE_FRAMEWORK_PATH`` environment variable may be set to a list of +directories to be searched for macOS frameworks by the :command:`find_library`, +:command:`find_package`, :command:`find_path` and :command:`find_file` commands. + + +This variable may hold a single directory or a list of directories separated +by ``:`` on UNIX or ``;`` on Windows (the same as the ``PATH`` environment +variable convention on those platforms). + +See also the :variable:`CMAKE_FRAMEWORK_PATH` CMake variable. diff --git a/Help/envvar/CMAKE_INCLUDE_PATH.rst b/Help/envvar/CMAKE_INCLUDE_PATH.rst new file mode 100644 index 0000000000..a42460d9d6 --- /dev/null +++ b/Help/envvar/CMAKE_INCLUDE_PATH.rst @@ -0,0 +1,13 @@ +CMAKE_INCLUDE_PATH +------------------ + +.. include:: ENV_VAR.txt + +The ``CMAKE_INCLUDE_PATH`` environment variable may be set to a list of +directories to be searched by the :command:`find_file` and :command:`find_path` commands. + +This variable may hold a single directory or a list of directories separated +by ``:`` on UNIX or ``;`` on Windows (the same as the ``PATH`` environment +variable convention on those platforms). + +See also the :variable:`CMAKE_INCLUDE_PATH` CMake variable. diff --git a/Help/envvar/CMAKE_LIBRARY_PATH.rst b/Help/envvar/CMAKE_LIBRARY_PATH.rst new file mode 100644 index 0000000000..a51100d2ea --- /dev/null +++ b/Help/envvar/CMAKE_LIBRARY_PATH.rst @@ -0,0 +1,13 @@ +CMAKE_LIBRARY_PATH +------------------ + +.. include:: ENV_VAR.txt + +The ``CMAKE_LIBRARY_PATH`` environment variable may be set to a list of +directories to be searched by the :command:`find_library` command. + +This variable may hold a single directory or a list of directories separated +by ``:`` on UNIX or ``;`` on Windows (the same as the ``PATH`` environment +variable convention on those platforms). + +See also the :variable:`CMAKE_LIBRARY_PATH` CMake variable. diff --git a/Help/envvar/CMAKE_PROGRAM_PATH.rst b/Help/envvar/CMAKE_PROGRAM_PATH.rst new file mode 100644 index 0000000000..bfc7a306ce --- /dev/null +++ b/Help/envvar/CMAKE_PROGRAM_PATH.rst @@ -0,0 +1,13 @@ +CMAKE_PROGRAM_PATH +------------------ + +.. include:: ENV_VAR.txt + +The ``CMAKE_PROGRAM_PATH`` environment variable may be set to a list of +directories to be searched by the :command:`find_program` command. + +This variable may hold a single directory or a list of directories separated +by ``:`` on UNIX or ``;`` on Windows (the same as the ``PATH`` environment +variable convention on those platforms). + +See also the :variable:`CMAKE_PROGRAM_PATH` CMake variable. diff --git a/Help/manual/cmake-env-variables.7.rst b/Help/manual/cmake-env-variables.7.rst index 1f0c9111aa..f7ae94d339 100644 --- a/Help/manual/cmake-env-variables.7.rst +++ b/Help/manual/cmake-env-variables.7.rst @@ -20,8 +20,13 @@ Environment Variables that Change Behavior .. toctree:: :maxdepth: 1 + /envvar/CMAKE_APPBUNDLE_PATH + /envvar/CMAKE_FRAMEWORK_PATH + /envvar/CMAKE_INCLUDE_PATH + /envvar/CMAKE_LIBRARY_PATH /envvar/CMAKE_MAXIMUM_RECURSION_DEPTH /envvar/CMAKE_PREFIX_PATH + /envvar/CMAKE_PROGRAM_PATH /envvar/SSL_CERT_DIR /envvar/SSL_CERT_FILE diff --git a/Help/variable/CMAKE_APPBUNDLE_PATH.rst b/Help/variable/CMAKE_APPBUNDLE_PATH.rst index 1c7ca51c2a..441ee8ebb2 100644 --- a/Help/variable/CMAKE_APPBUNDLE_PATH.rst +++ b/Help/variable/CMAKE_APPBUNDLE_PATH.rst @@ -4,3 +4,6 @@ CMAKE_APPBUNDLE_PATH :ref:`Semicolon-separated list ` of directories specifying a search path for macOS application bundles used by the :command:`find_program`, and :command:`find_package` commands. + +There is also an environment variable :envvar:`CMAKE_APPBUNDLE_PATH`, which is used +as an additional list of search directories. diff --git a/Help/variable/CMAKE_FRAMEWORK_PATH.rst b/Help/variable/CMAKE_FRAMEWORK_PATH.rst index 13ade4e5fc..8d62b028f7 100644 --- a/Help/variable/CMAKE_FRAMEWORK_PATH.rst +++ b/Help/variable/CMAKE_FRAMEWORK_PATH.rst @@ -5,3 +5,6 @@ CMAKE_FRAMEWORK_PATH for macOS frameworks used by the :command:`find_library`, :command:`find_package`, :command:`find_path`, and :command:`find_file` commands. + +There is also an environment variable :envvar:`CMAKE_FRAMEWORK_PATH`, which is used +as an additional list of search directories. diff --git a/Help/variable/CMAKE_INCLUDE_PATH.rst b/Help/variable/CMAKE_INCLUDE_PATH.rst index 4918e99602..3a4472a85f 100644 --- a/Help/variable/CMAKE_INCLUDE_PATH.rst +++ b/Help/variable/CMAKE_INCLUDE_PATH.rst @@ -3,5 +3,10 @@ CMAKE_INCLUDE_PATH :ref:`Semicolon-separated list ` of directories specifying a search path for the :command:`find_file` and :command:`find_path` commands. By default it -is empty, it is intended to be set by the project. See also -:variable:`CMAKE_SYSTEM_INCLUDE_PATH` and :variable:`CMAKE_PREFIX_PATH`. +is empty, it is intended to be set by the project. + + +There is also an environment variable :envvar:`CMAKE_INCLUDE_PATH`, which is used +as an additional list of search directories. + +See also :variable:`CMAKE_SYSTEM_INCLUDE_PATH` and :variable:`CMAKE_PREFIX_PATH`. diff --git a/Help/variable/CMAKE_LIBRARY_PATH.rst b/Help/variable/CMAKE_LIBRARY_PATH.rst index 8135b65818..4265982c2c 100644 --- a/Help/variable/CMAKE_LIBRARY_PATH.rst +++ b/Help/variable/CMAKE_LIBRARY_PATH.rst @@ -3,5 +3,9 @@ CMAKE_LIBRARY_PATH :ref:`Semicolon-separated list ` of directories specifying a search path for the :command:`find_library` command. By default it is empty, it is -intended to be set by the project. See also -:variable:`CMAKE_SYSTEM_LIBRARY_PATH` and :variable:`CMAKE_PREFIX_PATH`. +intended to be set by the project. + +There is also an environment variable :envvar:`CMAKE_LIBRARY_PATH`, which is used +as an additional list of search directories. + +See also :variable:`CMAKE_SYSTEM_LIBRARY_PATH` and :variable:`CMAKE_PREFIX_PATH`. diff --git a/Help/variable/CMAKE_PREFIX_PATH.rst b/Help/variable/CMAKE_PREFIX_PATH.rst index 3004b4b03e..54f2aecde0 100644 --- a/Help/variable/CMAKE_PREFIX_PATH.rst +++ b/Help/variable/CMAKE_PREFIX_PATH.rst @@ -10,7 +10,7 @@ documentation. By default this is empty. It is intended to be set by the project. -There is also an environment variable :envvar:`CMAKE_PREFIX_PATH`, which is is used +There is also an environment variable :envvar:`CMAKE_PREFIX_PATH`, which is used as an additional list of search prefixes. See also :variable:`CMAKE_SYSTEM_PREFIX_PATH`, :variable:`CMAKE_INCLUDE_PATH`, diff --git a/Help/variable/CMAKE_PROGRAM_PATH.rst b/Help/variable/CMAKE_PROGRAM_PATH.rst index 2d0c090df5..240bacb9a0 100644 --- a/Help/variable/CMAKE_PROGRAM_PATH.rst +++ b/Help/variable/CMAKE_PROGRAM_PATH.rst @@ -3,5 +3,9 @@ CMAKE_PROGRAM_PATH :ref:`Semicolon-separated list ` 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 -:variable:`CMAKE_SYSTEM_PROGRAM_PATH` and :variable:`CMAKE_PREFIX_PATH`. +intended to be set by the project. + +There is also an environment variable :envvar:`CMAKE_PROGRAM_PATH`, which is used +as an additional list of search directories. + +See also :variable:`CMAKE_SYSTEM_PROGRAM_PATH` and :variable:`CMAKE_PREFIX_PATH`. -- cgit v1.2.1