Skip to content

Commit

Permalink
Update pkg-config recommendation
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 e23b7c2 commit 88e229c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
1 change: 1 addition & 0 deletions reference/conanfile/attributes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ recipe or the package, then it is possible to exclude them from the check with t
configuration, which is a list of patterns (fnmatch) to exclude.


.. _upload_policy_attribute:

upload_policy
-------------
Expand Down
7 changes: 5 additions & 2 deletions reference/tools/gnu/pkgconfig.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Using pkg-config from Conan package instead of system

.. include:: ../../../common/experimental_warning.inc

In case of not having ``pkg-config`` available in the system, it is possible to use the ``pkg-config`` executable provided by a Conan package:
In case of not having ``pkg-config`` available in the system, it is possible to use the ``pkg-config`` executable provided by Conan ``tool_requires`` instead.:

.. code-block:: python
Expand Down Expand Up @@ -80,9 +80,12 @@ 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,
It's forbidden to upload or reuse this approach when creating a package, as the information may not be compatible with the host system,
resulting in errors when consuming the package.

When using this approach for wrapping system packages, it is recommended to use ``upload_policy = "skip"``
(see :ref:`upload_policy_attribute`) in the package recipe to avoid uploading the package.

Reference
---------

Expand Down

0 comments on commit 88e229c

Please sign in to comment.