Skip to content

Commit e23b7c2

Browse files
committed
Do not recommend system package usage
Signed-off-by: Uilian Ries <uilianries@gmail.com>
1 parent 9b1f9ef commit e23b7c2

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

reference/tools/gnu/pkgconfig.rst

+6-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Using PkgConfig to fill a ``cpp_info`` object
2929
---------------------------------------------
3030

3131
The ``PkgConfig`` class can be used to fill a ``CppInfo`` object with the information that will be consumed by the ``PkgConfigDeps`` generator later.
32-
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.
32+
This is a useful feature when packaging a proprietary package has a build system that only outputs ``.pc`` files for a known environment.
3333

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

81+
.. warning::
82+
83+
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,
84+
resulting in errors when consuming the package.
85+
8186
Reference
8287
---------
8388

0 commit comments

Comments
 (0)