Merge topic 'pkgc-variable-docs'

8817f3b131 PkgC: Document cmake variables

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !10493
This commit is contained in:
Brad King 2025-03-20 12:53:55 +00:00 committed by Kitware Robot
commit a28d24ce13
6 changed files with 45 additions and 0 deletions

View File

@ -254,6 +254,11 @@ Variables that Change Behavior
/variable/CMAKE_MESSAGE_LOG_LEVEL
/variable/CMAKE_MFC_FLAG
/variable/CMAKE_MODULE_PATH
/variable/CMAKE_PKG_CONFIG_DISABLE_UNINSTALLED
/variable/CMAKE_PKG_CONFIG_PC_LIB_DIRS
/variable/CMAKE_PKG_CONFIG_PC_PATH
/variable/CMAKE_PKG_CONFIG_SYSROOT_DIR
/variable/CMAKE_PKG_CONFIG_TOP_BUILD_DIR
/variable/CMAKE_POLICY_DEFAULT_CMPNNNN
/variable/CMAKE_POLICY_VERSION_MINIMUM
/variable/CMAKE_POLICY_WARNING_CMPNNNN

View File

@ -0,0 +1,9 @@
CMAKE_PKG_CONFIG_DISABLE_UNINSTALLED
------------------------------------
.. versionadded:: 4.0
Enable / Disable the default "uninstalled" search behavior of the
:command:`cmake_pkg_config` command. When this variable is false, package files
with an "-uninstalled" suffix have higher priority than exact package name
matches.

View File

@ -0,0 +1,8 @@
CMAKE_PKG_CONFIG_PC_LIB_DIRS
----------------------------
.. versionadded:: 4.0
:ref:`Semicolon-separated list <CMake Language Lists>` of primary paths which
the :command:`cmake_pkg_config` command will search for package files by
default. Also used to derive the ``pc_path`` package variable.

View File

@ -0,0 +1,8 @@
CMAKE_PKG_CONFIG_PC_PATH
------------------------
.. versionadded:: 4.0
:ref:`Semicolon-separated list <CMake Language Lists>` of supplementary paths
which the :command:`cmake_pkg_config` command will search for package files by
efault. Also used to derive the ``pc_path`` package variable.

View File

@ -0,0 +1,8 @@
CMAKE_PKG_CONFIG_SYSROOT_DIR
----------------------------
.. versionadded:: 4.0
Path prepended to ``-I`` include directories and ``-L`` library directories
extracted by the :command:`cmake_pkg_config` command by default. Also used to
derive the ``pc_sysrootdir`` package variable.

View File

@ -0,0 +1,7 @@
CMAKE_PKG_CONFIG_TOP_BUILD_DIR
------------------------------
.. versionadded:: 4.0
Path used to derive the ``pc_top_builddir`` package variable by the
:command:`cmake_pkg_config` command by default.