Skip to content

Commit

Permalink
Do not recommend system package usage
Browse files Browse the repository at this point in the history
Signed-off-by: Uilian Ries <[email protected]>
  • Loading branch information
uilianries committed Aug 14, 2024
1 parent 9b1f9ef commit e23b7c2
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion reference/tools/gnu/pkgconfig.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Using PkgConfig to fill a ``cpp_info`` object
---------------------------------------------

The ``PkgConfig`` class can be used to fill a ``CppInfo`` object with the information that will be consumed by the ``PkgConfigDeps`` generator later.
This is a useful feature when packaging a system library that provides a ``.pc`` file, or when a proprietary package has a build system that only outputs ``.pc`` files.
This is a useful feature when packaging a proprietary package has a build system that only outputs ``.pc`` files for a known environment.

.. code-block:: python
Expand Down Expand Up @@ -78,6 +78,11 @@ The ``.pc`` information will be extracted from the ``cpp_info.json`` file locate
This way, the ``PkgConfig`` will not need to invoke the ``pkg-config`` executable again to extract the information from the ``.pc`` file,
when consuming the package.

.. warning::

It's not recommended to use this approach when creating a "system" package recipe, as the packaged information may not be compatible with the host system,
resulting in errors when consuming the package.

Reference
---------

Expand Down

0 comments on commit e23b7c2

Please sign in to comment.