1
0
mirror of https://git.yoctoproject.org/poky synced 2026-06-01 00:59:48 +00:00

ref-manual: Updates to check-recipe-upgrade devtool command

I updated the section to include more detail on what the user
sees in the returned table.

(From yocto-docs rev: 34b801d6fa61290be51e589c4cc759b59620edf1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2019-05-30 10:12:03 -07:00
committed by Richard Purdie
parent 4f08ca238e
commit e68171d806
@@ -427,7 +427,6 @@
</para> </para>
</section> </section>
<section id='devtool-checking-on-the-upgrade-status-of-a-recipe'> <section id='devtool-checking-on-the-upgrade-status-of-a-recipe'>
<title>Checking on the Upgrade Status of a Recipe</title> <title>Checking on the Upgrade Status of a Recipe</title>
@@ -441,9 +440,26 @@
To check on the upgrade status of a recipe, use the To check on the upgrade status of a recipe, use the
<filename>devtool check-upgrade-status</filename> command. <filename>devtool check-upgrade-status</filename> command.
The command displays a table of your current recipe versions, The command displays a table of your current recipe versions,
the latest upstream versions, and any additional information the latest upstream versions, the email address of the recipe's
such as commit hash strings and reasons you might be able to maintainer, and any additional information such as commit hash
upgrade a particular recipe. strings and reasons you might be able to upgrade a particular
recipe.
<note><title>NOTES:</title>
<itemizedlist>
<listitem><para>
For the <filename>oe-core</filename> layer, recipe
maintainers come from the
<ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc'><filename>maintainers.inc</filename></ulink>
file.
</para></listitem>
<listitem><para>
If the recipe is using the
<ulink url='&YOCTO_DOCS_BB_URL;#git-fetcher'>Git fetcher</ulink>
rather than a tarball, the commit hash points to the
commit that matches the recipe's latest version tag.
</para></listitem>
</itemizedlist>
</note>
</para> </para>
<para> <para>
@@ -465,8 +481,29 @@
-h, --help show this help message and exit -h, --help show this help message and exit
--all, -a Show all recipes, not just recipes needing upgrade --all, -a Show all recipes, not just recipes needing upgrade
</literallayout> </literallayout>
Following is a partial example table which reports on all the </para>
recipes:
<para>
Unless you provide a specific recipe name on the command line,
the command checks all recipes in all configured layers.
</para>
<para>
Following is a partial example table that reports on all the
recipes.
Notice the reported reason for not upgrading the
<filename>base-passwd</filename> recipe.
In this example, while a new version is available upstream,
you do not want to use it because the dependency on
<filename>cdebconf</filename> is not easily satisfied.
<note>
When a reason for not upgrading displays, the reason is
usually written into the recipe using the
<filename>RECIPE_NO_UPDATE_REASON</filename> variable.
See the
<ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb'><filename>base-passwd.bb</filename></ulink>
recipe for an example.
</note>
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ devtool check-upgrade-status $ devtool check-upgrade-status
... ...