summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/variables.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 1d4e2e2be6..ca1701e7c6 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6726,6 +6726,28 @@ system and gives an overview of their function and contents.
6726 :term:`PREFERRED_PROVIDERS` 6726 :term:`PREFERRED_PROVIDERS`
6727 See :term:`bitbake:PREFERRED_PROVIDERS` in the BitBake manual. 6727 See :term:`bitbake:PREFERRED_PROVIDERS` in the BitBake manual.
6728 6728
6729 :term:`PREFERRED_RPROVIDER`
6730 The :term:`PREFERRED_RPROVIDER` variable works like the
6731 :term:`PREFERRED_PROVIDER` variable, but it denotes packages that provide a
6732 *runtime* component. Runtime providers are declared in recipes that set
6733 the :term:`RPROVIDES` variable for a specific package.
6734
6735 For example::
6736
6737 PREFERRED_RPROVIDER_virtual-x-terminal-emulator = "rxvt-unicode"
6738
6739 This statement sets the runtime provider for the X terminal emulator to
6740 ``rxvt-unicode``. The ``rxvt-unicode`` package is a runtime provider of
6741 this component because the ``rxvt-unicode`` recipe set the following
6742 :term:`RPROVIDES` definition for the ``rxvt-unicode`` (``${PN}``)
6743 package::
6744
6745 RPROVIDES:${PN} = "virtual-x-terminal-emulator"
6746
6747 For more information on virtual providers, see the
6748 ":ref:`dev-manual/new-recipe:using virtual providers`" section in the
6749 Yocto Project Development Tasks Manual.
6750
6729 :term:`PREFERRED_VERSION` 6751 :term:`PREFERRED_VERSION`
6730 If there are multiple versions of a recipe available, this variable 6752 If there are multiple versions of a recipe available, this variable
6731 determines which version should be given preference. You must always 6753 determines which version should be given preference. You must always