summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-05-30 10:12:03 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2019-06-07 13:57:41 +0100
commit99f9a53b6b22d0910c53a51f6fa4002e32c032e3 (patch)
tree9919b7f04b56ad7d3ef2fa66fa0a271231adbf6e /documentation/ref-manual
parentbbdf0453d032201f24f318e53522f0ce48a38a46 (diff)
downloadpoky-99f9a53b6b22d0910c53a51f6fa4002e32c032e3.tar.gz
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: 671279548dde7f356888ba1ad1551b8bb1f70a65) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-devtool-reference.xml49
1 files changed, 43 insertions, 6 deletions
diff --git a/documentation/ref-manual/ref-devtool-reference.xml b/documentation/ref-manual/ref-devtool-reference.xml
index b35aa039b1..14395a7ffd 100644
--- a/documentation/ref-manual/ref-devtool-reference.xml
+++ b/documentation/ref-manual/ref-devtool-reference.xml
@@ -427,7 +427,6 @@
427 </para> 427 </para>
428 </section> 428 </section>
429 429
430
431 <section id='devtool-checking-on-the-upgrade-status-of-a-recipe'> 430 <section id='devtool-checking-on-the-upgrade-status-of-a-recipe'>
432 <title>Checking on the Upgrade Status of a Recipe</title> 431 <title>Checking on the Upgrade Status of a Recipe</title>
433 432
@@ -441,9 +440,26 @@
441 To check on the upgrade status of a recipe, use the 440 To check on the upgrade status of a recipe, use the
442 <filename>devtool check-upgrade-status</filename> command. 441 <filename>devtool check-upgrade-status</filename> command.
443 The command displays a table of your current recipe versions, 442 The command displays a table of your current recipe versions,
444 the latest upstream versions, and any additional information 443 the latest upstream versions, the email address of the recipe's
445 such as commit hash strings and reasons you might be able to 444 maintainer, and any additional information such as commit hash
446 upgrade a particular recipe. 445 strings and reasons you might be able to upgrade a particular
446 recipe.
447 <note><title>NOTES:</title>
448 <itemizedlist>
449 <listitem><para>
450 For the <filename>oe-core</filename> layer, recipe
451 maintainers come from the
452 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc'><filename>maintainers.inc</filename></ulink>
453 file.
454 </para></listitem>
455 <listitem><para>
456 If the recipe is using the
457 <ulink url='&YOCTO_DOCS_BB_URL;#git-fetcher'>Git fetcher</ulink>
458 rather than a tarball, the commit hash points to the
459 commit that matches the recipe's latest version tag.
460 </para></listitem>
461 </itemizedlist>
462 </note>
447 </para> 463 </para>
448 464
449 <para> 465 <para>
@@ -465,8 +481,29 @@
465 -h, --help show this help message and exit 481 -h, --help show this help message and exit
466 --all, -a Show all recipes, not just recipes needing upgrade 482 --all, -a Show all recipes, not just recipes needing upgrade
467 </literallayout> 483 </literallayout>
468 Following is a partial example table which reports on all the 484 </para>
469 recipes: 485
486 <para>
487 Unless you provide a specific recipe name on the command line,
488 the command checks all recipes in all configured layers.
489 </para>
490
491 <para>
492 Following is a partial example table that reports on all the
493 recipes.
494 Notice the reported reason for not upgrading the
495 <filename>base-passwd</filename> recipe.
496 In this example, while a new version is available upstream,
497 you do not want to use it because the dependency on
498 <filename>cdebconf</filename> is not easily satisfied.
499 <note>
500 When a reason for not upgrading displays, the reason is
501 usually written into the recipe using the
502 <filename>RECIPE_NO_UPDATE_REASON</filename> variable.
503 See the
504 <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>
505 recipe for an example.
506 </note>
470 <literallayout class='monospaced'> 507 <literallayout class='monospaced'>
471 $ devtool check-upgrade-status 508 $ devtool check-upgrade-status
472 ... 509 ...