mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-12-31 19:00:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: add documentation for some CMAKE_XXX_PATH env.vars

Browse Source 
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.
This commit is contained in:
Alex Neundorf
2023-04-30 19:22:24 +02:00
parent 73ce0b792f
commit e40d4eb644
12 changed files with 99 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Help/envvar/CMAKE_APPBUNDLE_PATH.rst Normal file
View File

@@ -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.

15
Help/envvar/CMAKE_FRAMEWORK_PATH.rst Normal file
View File

@@ -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.

13
Help/envvar/CMAKE_INCLUDE_PATH.rst Normal file
View File

@@ -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.

13
Help/envvar/CMAKE_LIBRARY_PATH.rst Normal file
View File

@@ -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.

13
Help/envvar/CMAKE_PROGRAM_PATH.rst Normal file
View File

@@ -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.

5
Help/manual/cmake-env-variables.7.rst
View File

@@ -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

3
Help/variable/CMAKE_APPBUNDLE_PATH.rst
View File

@@ -4,3 +4,6 @@ CMAKE_APPBUNDLE_PATH
:ref:`Semicolon-separated list <CMake Language Lists>` 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.

3
Help/variable/CMAKE_FRAMEWORK_PATH.rst
View File

@@ -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.

9
Help/variable/CMAKE_INCLUDE_PATH.rst
View File

@@ -3,5 +3,10 @@ CMAKE_INCLUDE_PATH
:ref:`Semicolon-separated list <CMake Language Lists>` 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`.

8
Help/variable/CMAKE_LIBRARY_PATH.rst
View File

@@ -3,5 +3,9 @@ CMAKE_LIBRARY_PATH
:ref:`Semicolon-separated list <CMake Language Lists>` 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`.

2
Help/variable/CMAKE_PREFIX_PATH.rst
View File

@@ -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`,

8
Help/variable/CMAKE_PROGRAM_PATH.rst
View File

@@ -3,5 +3,9 @@ CMAKE_PROGRAM_PATH
:ref:`Semicolon-separated list <CMake Language Lists>` 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`.