mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-09 07:11:05 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Correct FindPkgConfig version tags

Browse Source 
Two features in FindPkgConfig were added in a CMake version where
they were initially broken, and could only be used once the
implementation was fixed in a later version.

Previously, the docs contained a `.. versionadded` tag denoting the
version where the _broken_ implementation was introduced (its true
"version added", if we're being literal), with a comment in the
documentation source noting that the feature didn't actually work
correctly until whatever later version the comment specifies.

Since that's completely backwards, from a user perspective, reverse
the documentation so that the `.. versionadded` message shows when
the feature first worked **correctly**, with a comment noting that
support was technically introduced in an earlier version, but in a
broken/nonfunctioning state.
This commit is contained in:
FeRD (Frank Dana)
2024-11-19 02:23:25 -05:00
parent 0662a7b4d7
commit c14a9c4648
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Modules/FindPkgConfig.cmake
View File

@@ -730,7 +730,7 @@ endmacro()
When the ``QUIET`` argument is given, no status messages will be printed.
.. versionadded:: 3.1
.. versionadded:: 3.3
The :variable:`CMAKE_PREFIX_PATH`,
:variable:`CMAKE_FRAMEWORK_PATH`, and :variable:`CMAKE_APPBUNDLE_PATH` cache
and environment variables will be added to the ``pkg-config`` search path.
@@ -740,14 +740,14 @@ endmacro()
The :variable:`PKG_CONFIG_USE_CMAKE_PREFIX_PATH` variable set to ``FALSE``
disables this behavior globally.
.. This didn't actually work until 3.3.
.. This was actually added in 3.1, but didn't work until 3.3.
.. versionadded:: 3.6
.. versionadded:: 3.7
The ``IMPORTED_TARGET`` argument will create an imported target named
``PkgConfig::<prefix>`` that can be passed directly as an argument to
:command:`target_link_libraries`.
.. This didn't actually work until 3.7.
.. This was actually added in 3.6, but didn't work until 3.7.
.. versionadded:: 3.13
The ``GLOBAL`` argument will make the