summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-05-28 18:26:21 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2019-06-18 11:30:38 +0100
commitcca5eb8ec3f6ffb54b1085b9b1f8623bc9e6a6bc (patch)
tree1bd5d15a94bdba1204fe6b9d114d2bfeb5d80458 /documentation
parentcd8304bfd70488dabaa2172810ca8e03ba134616 (diff)
downloadpoky-cca5eb8ec3f6ffb54b1085b9b1f8623bc9e6a6bc.tar.gz
ref-manual: New section "Checking Upgrade Status of a Recipe"
I added a new section showcasing the "devtool check-upgrade-status" command. Also, added a note in the "Upgrading a Recipe" section" to tell the reader they might want to check on a recipe's upgrade status before upgrading a recipe. (From yocto-docs rev: ca091498a274b9a7a44b0d6d5ee826c1d2bd6a3c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-devtool-reference.xml72
1 files changed, 72 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-devtool-reference.xml b/documentation/ref-manual/ref-devtool-reference.xml
index a7f5f8e25f..b35aa039b1 100644
--- a/documentation/ref-manual/ref-devtool-reference.xml
+++ b/documentation/ref-manual/ref-devtool-reference.xml
@@ -427,6 +427,71 @@
427 </para> 427 </para>
428 </section> 428 </section>
429 429
430
431 <section id='devtool-checking-on-the-upgrade-status-of-a-recipe'>
432 <title>Checking on the Upgrade Status of a Recipe</title>
433
434 <para>
435 Upstream recipes change over time.
436 Consequently, you might find that you need to determine if you
437 can upgrade a recipe to a newer version.
438 </para>
439
440 <para>
441 To check on the upgrade status of a recipe, use the
442 <filename>devtool check-upgrade-status</filename> command.
443 The command displays a table of your current recipe versions,
444 the latest upstream versions, and any additional information
445 such as commit hash strings and reasons you might be able to
446 upgrade a particular recipe.
447 </para>
448
449 <para>
450 As with all <filename>devtool</filename> commands, you can get
451 help on the individual command:
452 <literallayout class='monospaced'>
453 $ devtool check-upgrade-status -h
454 NOTE: Starting bitbake server...
455 usage: devtool check-upgrade-status [-h] [--all] [recipe [recipe ...]]
456
457 Prints a table of recipes together with versions currently provided by
458 recipes, and latest upstream versions, when there is a later version available
459
460 arguments:
461 recipe Name of the recipe to report (omit to report upgrade info for
462 all recipes)
463
464 options:
465 -h, --help show this help message and exit
466 --all, -a Show all recipes, not just recipes needing upgrade
467 </literallayout>
468 Following is a partial example table which reports on all the
469 recipes:
470 <literallayout class='monospaced'>
471 $ devtool check-upgrade-status
472 ...
473 NOTE: acpid 2.0.30 2.0.31
474 Ross Burton &lt;ross.burton@intel.com&gt;
475 NOTE: u-boot-fw-utils 2018.11 2019.01
476 Marek Vasut &lt;marek.vasut@gmail.com&gt;
477 d3689267f92c5956e09cc7d1baa4700141662bff
478 NOTE: u-boot-tools 2018.11 2019.01
479 Marek Vasut &lt;marek.vasut@gmail.com&gt;
480 d3689267f92c5956e09cc7d1baa4700141662bff
481 .
482 .
483 .
484 NOTE: base-passwd 3.5.29 3.5.45
485 Anuj Mittal &lt;anuj.mittal@intel.com&gt; cannot be updated due to: Version
486 3.5.38 requires cdebconf for update-passwd utility
487 NOTE: busybox 1.29.2 1.30.0
488 Andrej Valek &lt;andrej.valek@siemens.com&gt;
489 NOTE: dbus-test 1.12.10 1.12.12
490 Chen Qi &lt;Qi.Chen@windriver.com&gt;
491 </literallayout>
492 </para>
493 </section>
494
430 <section id='devtool-upgrading-a-recipe'> 495 <section id='devtool-upgrading-a-recipe'>
431 <title>Upgrading a Recipe</title> 496 <title>Upgrading a Recipe</title>
432 497
@@ -441,6 +506,13 @@
441 section of the Yocto Project Development Tasks Manual. 506 section of the Yocto Project Development Tasks Manual.
442 This section overviews the <filename>devtool upgrade</filename> 507 This section overviews the <filename>devtool upgrade</filename>
443 command. 508 command.
509 <note>
510 Before you upgrade a recipe, you can check on its upgrade
511 status.
512 See the
513 "<link linkend='devtool-checking-on-the-upgrade-status-of-a-recipe'>Checking on the Upgrade Status of a Recipe</link>"
514 for more information.
515 </note>
444 </para> 516 </para>
445 517
446 <para> 518 <para>