mirror of
https://github.com/Kitware/CMake.git
synced 2025-10-16 22:37:30 +08:00
Help: Use appropriate list types in FindPkgConfig
This commit is contained in:

committed by
Craig Scott

parent
88ef5737a2
commit
74b3eacdc7
@@ -9,12 +9,14 @@ A ``pkg-config`` module for CMake.
|
||||
|
||||
Finds the ``pkg-config`` executable and adds the :command:`pkg_get_variable`,
|
||||
:command:`pkg_check_modules` and :command:`pkg_search_module` commands. The
|
||||
following variables will also be set::
|
||||
following variables will also be set:
|
||||
|
||||
PKG_CONFIG_FOUND ... if pkg-config executable was found
|
||||
PKG_CONFIG_EXECUTABLE ... pathname of the pkg-config program
|
||||
PKG_CONFIG_VERSION_STRING ... the version of the pkg-config program found
|
||||
(since CMake 2.8.8)
|
||||
``PKG_CONFIG_FOUND``
|
||||
if pkg-config executable was found
|
||||
``PKG_CONFIG_EXECUTABLE``
|
||||
pathname of the pkg-config program
|
||||
``PKG_CONFIG_VERSION_STRING``
|
||||
version of pkg-config (since CMake 2.8.8)
|
||||
|
||||
#]========================================]
|
||||
|
||||
@@ -543,27 +545,36 @@ endmacro()
|
||||
Each ``<moduleSpec>`` can be either a bare module name or it can be a
|
||||
module name with a version constraint (operators ``=``, ``<``, ``>``,
|
||||
``<=`` and ``>=`` are supported). The following are examples for a module
|
||||
named ``foo`` with various constraints::
|
||||
named ``foo`` with various constraints:
|
||||
|
||||
foo # Any version matches
|
||||
foo<2 # Only match versions before 2
|
||||
foo>=3.1 # Match any version from 3.1 or later
|
||||
foo=1.2.3 # Foo must be exactly version 1.2.3
|
||||
- ``foo`` matches any version.
|
||||
- ``foo<2`` only matches versions before 2.
|
||||
- ``foo>=3.1`` matches any version from 3.1 or later.
|
||||
- ``foo=1.2.3`` requires that foo must be exactly version 1.2.3.
|
||||
|
||||
The following variables may be set upon return. Two sets of values exist,
|
||||
one for the common case (``<XXX> = <prefix>``) and another for the
|
||||
information ``pkg-config`` provides when it is called with the ``--static``
|
||||
option (``<XXX> = <prefix>_STATIC``)::
|
||||
option (``<XXX> = <prefix>_STATIC``)
|
||||
|
||||
<XXX>_FOUND ... set to 1 if module(s) exist
|
||||
<XXX>_LIBRARIES ... only the libraries (without the '-l')
|
||||
<XXX>_LINK_LIBRARIES ... the libraries and their absolute paths
|
||||
<XXX>_LIBRARY_DIRS ... the paths of the libraries (without the '-L')
|
||||
<XXX>_LDFLAGS ... all required linker flags
|
||||
<XXX>_LDFLAGS_OTHER ... all other linker flags
|
||||
<XXX>_INCLUDE_DIRS ... the '-I' preprocessor flags (without the '-I')
|
||||
<XXX>_CFLAGS ... all required cflags
|
||||
<XXX>_CFLAGS_OTHER ... the other compiler flags
|
||||
``<XXX>_FOUND``
|
||||
set to 1 if module(s) exist
|
||||
``<XXX>_LIBRARIES``
|
||||
only the libraries (without the '-l')
|
||||
``<XXX>_LINK_LIBRARIES``
|
||||
the libraries and their absolute paths
|
||||
``<XXX>_LIBRARY_DIRS``
|
||||
the paths of the libraries (without the '-L')
|
||||
``<XXX>_LDFLAGS``
|
||||
all required linker flags
|
||||
``<XXX>_LDFLAGS_OTHER``
|
||||
all other linker flags
|
||||
``<XXX>_INCLUDE_DIRS``
|
||||
the '-I' preprocessor flags (without the '-I')
|
||||
``<XXX>_CFLAGS``
|
||||
all required cflags
|
||||
``<XXX>_CFLAGS_OTHER``
|
||||
the other compiler flags
|
||||
|
||||
All but ``<XXX>_FOUND`` may be a :ref:`;-list <CMake Language Lists>` if the
|
||||
associated variable returned from ``pkg-config`` has multiple values.
|
||||
@@ -571,12 +582,16 @@ endmacro()
|
||||
There are some special variables whose prefix depends on the number of
|
||||
``<moduleSpec>`` given. When there is only one ``<moduleSpec>``,
|
||||
``<YYY>`` will simply be ``<prefix>``, but if two or more ``<moduleSpec>``
|
||||
items are given, ``<YYY>`` will be ``<prefix>_<moduleName>``::
|
||||
items are given, ``<YYY>`` will be ``<prefix>_<moduleName>``
|
||||
|
||||
<YYY>_VERSION ... version of the module
|
||||
<YYY>_PREFIX ... prefix directory of the module
|
||||
<YYY>_INCLUDEDIR ... include directory of the module
|
||||
<YYY>_LIBDIR ... lib directory of the module
|
||||
``<YYY>_VERSION``
|
||||
version of the module
|
||||
``<YYY>_PREFIX``
|
||||
prefix directory of the module
|
||||
``<YYY>_INCLUDEDIR``
|
||||
include directory of the module
|
||||
``<YYY>_LIBDIR``
|
||||
lib directory of the module
|
||||
|
||||
Examples
|
||||
|
||||
|
Reference in New Issue
Block a user