mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-01-29 21:08:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: improve documentation for RECIPE_NO_UPDATE_REASON

Browse Source 
This add a description of this variable to the variable index,
and clarifies the explanations given in the devtool reference
section.

(From yocto-docs rev: 034b976addd0db6da31c4bacdbea21f2d47c00dc)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2021-09-15 11:36:57 +02:00
committed by Richard Purdie
parent 6c5986ebfe
commit 6a9e7fb010
2 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
documentation/ref-manual/devtool-reference.rst
View File

@@ -383,15 +383,10 @@ Following is a partial example table that reports on all the recipes.
Notice the reported reason for not upgrading the ``base-passwd`` recipe.
In this example, while a new version is available upstream, you do not
want to use it because the dependency on ``cdebconf`` is not easily
satisfied.
.. note::
When a reason for not upgrading displays, the reason is usually
written into the recipe using the ``RECIPE_NO_UPDATE_REASON``
variable. See the
:yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>`
recipe for an example.
satisfied. Maintainers can explicit the reason that is shown by adding
the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe.
See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>`
for an example.
::

7
documentation/ref-manual/variables.rst
View File

@@ -6132,6 +6132,13 @@ system and gives an overview of their function and contents.
BitBake User Manual for additional information on tasks and
dependencies.
:term:`RECIPE_NO_UPDATE_REASON`
If a recipe should not be replaced by a more recent upstream version,
putting the reason why in this variable in a recipe allows
``devtool check-upgrade-status`` command to display it, as explained
in the ":ref:`ref-manual/devtool-reference:checking on the upgrade status of a recipe`"
section.
:term:`REQUIRED_DISTRO_FEATURES`
When inheriting the
:ref:`features_check <ref-classes-features_check>`