Skip to content

Commit

Permalink
Explanation about components in the pkg_config generator
Browse files Browse the repository at this point in the history
  • Loading branch information
danimtb committed Jul 29, 2020
1 parent 453288c commit c76a6ab
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions reference/generators/pkg_config.rst
Expand Up @@ -4,11 +4,19 @@
pkg_config
==========

Generates N files named ``<PKG-NAME>.pc`` (where ``<PKG-NAME`` is the name declared by dependencies in
Generates pkg-config files named *<PKG-NAME>.pc* (where ``<PKG-NAME`` is the name declared by dependencies in
``cpp_info.name`` or in ``cpp_info.names["pkg_config"]`` if specified), containing a
valid pkg-config file syntax. The ``prefix`` variable is automatically adjusted to the ``package_folder``.

Go to :ref:`Integrations/pkg-config and pc files/Use the pkg_config generator<pkg_config_generator_example>`
if you want to learn how to use this generator.
Components
++++++++++

If a recipe uses :ref:`components<package_information_components>`, the files generated will be *<COMP-NAME>.pc* with their corresponding
flags and require relations.

Additionally, a *<PKG-NAME>.pc* is generated to maintain compatibility for consumers with recipes that start supporting components. This
*<PKG-NAME>.pc* file will declare the all the components of the package as requires while the rest of the fields will be empty, relying on
the propagation of flags coming from the components *<COMP-NAME>.pc* files.

Go to :ref:`Integrations/pkg-config and pc files/Use the pkg_config generator<pkg_config_generator_example>`
if you want to learn how to use this generator.

0 comments on commit c76a6ab

Please sign in to comment.