Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit c313918

Browse files
committedAug 14, 2024·
Update pkg-config recommendation
Signed-off-by: Uilian Ries <[email protected]>
1 parent e23b7c2 commit c313918

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed
 

‎reference/conanfile/attributes.rst

+1
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,7 @@ recipe or the package, then it is possible to exclude them from the check with t
126126
configuration, which is a list of patterns (fnmatch) to exclude.
127127

128128

129+
.. _upload_policy_attribute:
129130

130131
upload_policy
131132
-------------

‎reference/tools/gnu/pkgconfig.rst

+7-4
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ However, ``PkgConfig`` will invoke the ``pkg-config`` executable to extract the
4242
The ``pkg-config`` executable must be available in the system path for this case, otherwise, it will fail when installing the consumed package.
4343

4444

45-
Using pkg-config from Conan package instead of system
46-
-----------------------------------------------------
45+
Using pkg-config from Conan tool_requires instead of system
46+
-----------------------------------------------------------
4747

4848
.. include:: ../../../common/experimental_warning.inc
4949

50-
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:
50+
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.:
5151

5252
.. code-block:: python
5353
@@ -80,9 +80,12 @@ when consuming the package.
8080

8181
.. warning::
8282

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,
83+
It's forbidden to upload or reuse this approach when creating a package, as the information may not be compatible with the host system,
8484
resulting in errors when consuming the package.
8585

86+
When using this approach for wrapping system packages, it is recommended to use ``upload_policy = "skip"``
87+
(see :ref:`upload_policy_attribute`) in the package recipe to avoid uploading the package.
88+
8689
Reference
8790
---------
8891

0 commit comments

Comments
 (0)
Please sign in to comment.