summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-02-08 18:18:43 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-02-10 11:03:36 +0000
commit4681a9e6ce67745197a2ae56d7ffd2a42e3ebce3 (patch)
tree830f4cd9ad4a8d38d3671c7c83e6bc5b44b2dd85 /documentation
parent1ea54b0db349f9452038a630dcc3013554b9f9bc (diff)
downloadpoky-4681a9e6ce67745197a2ae56d7ffd2a42e3ebce3.tar.gz
ref-manual: improve "devtool check-upgrade-status" explanations
- Fix broken link to a .bb file - Clarify the explanations (From yocto-docs rev: 937ef39cb4d04da388b1945d741820089daa2780) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/devtool-reference.rst19
1 files changed, 11 insertions, 8 deletions
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index 6aa09f6d6f..32e64d02a2 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -378,14 +378,7 @@ command::
378Unless you provide a specific recipe name on the command line, the 378Unless you provide a specific recipe name on the command line, the
379command checks all recipes in all configured layers. 379command checks all recipes in all configured layers.
380 380
381Following is a partial example table that reports on all the recipes. 381Following is a partial example table that reports on all the recipes::
382Notice the reported reason for not upgrading the ``base-passwd`` recipe.
383In this example, while a new version is available upstream, you do not
384want to use it because the dependency on ``cdebconf`` is not easily
385satisfied. Maintainers can explicit the reason that is shown by adding
386the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe.
387See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>`
388for an example::
389 382
390 $ devtool check-upgrade-status 383 $ devtool check-upgrade-status
391 ... 384 ...
@@ -396,6 +389,16 @@ for an example::
396 INFO: base-passwd 3.5.29 3.5.51 Anuj Mittal <anuj.mittal@intel.com> cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility 389 INFO: base-passwd 3.5.29 3.5.51 Anuj Mittal <anuj.mittal@intel.com> cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility
397 ... 390 ...
398 391
392Notice the reported reason for not upgrading the ``base-passwd`` recipe.
393In this example, while a new version is available upstream, you do not
394want to use it because the dependency on ``cdebconf`` is not easily
395satisfied. Maintainers can explicit the reason that is shown by adding
396the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe.
397See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb?h=kirkstone>`
398for an example::
399
400 RECIPE_NO_UPDATE_REASON = "Version 3.5.38 requires cdebconf for update-passwd utility"
401
399Last but not least, you may set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` 402Last but not least, you may set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1``
400in a recipe when there's currently no way to determine its latest upstream 403in a recipe when there's currently no way to determine its latest upstream
401version. 404version.