diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-09-15 11:36:57 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-09-18 13:03:45 +0100 |
commit | 6a9e7fb0104f2f4af680be28e8cb3183a5aecf8a (patch) | |
tree | cddb896055741af54b4077dac84cd7813dd434e8 /documentation/ref-manual | |
parent | 6c5986ebfee69257de9caafec9896dce96c55955 (diff) | |
download | poky-6a9e7fb0104f2f4af680be28e8cb3183a5aecf8a.tar.gz |
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 <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/devtool-reference.rst | 13 | ||||
-rw-r--r-- | 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. | |||
383 | Notice the reported reason for not upgrading the ``base-passwd`` recipe. | 383 | Notice the reported reason for not upgrading the ``base-passwd`` recipe. |
384 | In this example, while a new version is available upstream, you do not | 384 | In this example, while a new version is available upstream, you do not |
385 | want to use it because the dependency on ``cdebconf`` is not easily | 385 | want to use it because the dependency on ``cdebconf`` is not easily |
386 | satisfied. | 386 | satisfied. Maintainers can explicit the reason that is shown by adding |
387 | 387 | the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe. | |
388 | .. note:: | 388 | See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` |
389 | 389 | for an example. | |
390 | When a reason for not upgrading displays, the reason is usually | ||
391 | written into the recipe using the ``RECIPE_NO_UPDATE_REASON`` | ||
392 | variable. See the | ||
393 | :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` | ||
394 | recipe for an example. | ||
395 | 390 | ||
396 | :: | 391 | :: |
397 | 392 | ||
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. | |||
6132 | BitBake User Manual for additional information on tasks and | 6132 | BitBake User Manual for additional information on tasks and |
6133 | dependencies. | 6133 | dependencies. |
6134 | 6134 | ||
6135 | :term:`RECIPE_NO_UPDATE_REASON` | ||
6136 | If a recipe should not be replaced by a more recent upstream version, | ||
6137 | putting the reason why in this variable in a recipe allows | ||
6138 | ``devtool check-upgrade-status`` command to display it, as explained | ||
6139 | in the ":ref:`ref-manual/devtool-reference:checking on the upgrade status of a recipe`" | ||
6140 | section. | ||
6141 | |||
6135 | :term:`REQUIRED_DISTRO_FEATURES` | 6142 | :term:`REQUIRED_DISTRO_FEATURES` |
6136 | When inheriting the | 6143 | When inheriting the |
6137 | :ref:`features_check <ref-classes-features_check>` | 6144 | :ref:`features_check <ref-classes-features_check>` |