From 6a9e7fb0104f2f4af680be28e8cb3183a5aecf8a Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Wed, 15 Sep 2021 11:36:57 +0200 Subject: [PATCH] ref-manual: improve documentation for RECIPE_NO_UPDATE_REASON 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/devtool-reference.rst | 13 ++++--------- documentation/ref-manual/variables.rst | 7 +++++++ 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index 3e06864f76..6c5f433121 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst @@ -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 ` - 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 ` +for an example. :: diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 5c02033a54..dbe02ab27a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -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 `