summaryrefslogtreecommitdiffstats
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
parentcd8304bfd70488dabaa2172810ca8e03ba134616 (diff)
downloadpoky-cca5eb8ec3f6ffb54b1085b9b1f8623bc9e6a6bc.tar.gz
poky-cca5eb8ec3f6ffb54b1085b9b1f8623bc9e6a6bc.tar.bz2
poky-cca5eb8ec3f6ffb54b1085b9b1f8623bc9e6a6bc.zip
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>
-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 @@
</para>
</section>
+
+ <section id='devtool-checking-on-the-upgrade-status-of-a-recipe'>
+ <title>Checking on the Upgrade Status of a Recipe</title>
+
+ <para>
+ Upstream recipes change over time.
+ Consequently, you might find that you need to determine if you
+ can upgrade a recipe to a newer version.
+ </para>
+
+ <para>
+ To check on the upgrade status of a recipe, use the
+ <filename>devtool check-upgrade-status</filename> command.
+ The command displays a table of your current recipe versions,
+ the latest upstream versions, and any additional information
+ such as commit hash strings and reasons you might be able to
+ upgrade a particular recipe.
+ </para>
+
+ <para>
+ As with all <filename>devtool</filename> commands, you can get
+ help on the individual command:
+ <literallayout class='monospaced'>
+ $ devtool check-upgrade-status -h
+ NOTE: Starting bitbake server...
+ usage: devtool check-upgrade-status [-h] [--all] [recipe [recipe ...]]
+
+ Prints a table of recipes together with versions currently provided by
+ recipes, and latest upstream versions, when there is a later version available
+
+ arguments:
+ recipe Name of the recipe to report (omit to report upgrade info for
+ all recipes)
+
+ options:
+ -h, --help show this help message and exit
+ --all, -a Show all recipes, not just recipes needing upgrade
+ </literallayout>
+ Following is a partial example table which reports on all the
+ recipes:
+ <literallayout class='monospaced'>
+ $ devtool check-upgrade-status
+ ...
+ NOTE: acpid 2.0.30 2.0.31
+ Ross Burton &lt;ross.burton@intel.com&gt;
+ NOTE: u-boot-fw-utils 2018.11 2019.01
+ Marek Vasut &lt;marek.vasut@gmail.com&gt;
+ d3689267f92c5956e09cc7d1baa4700141662bff
+ NOTE: u-boot-tools 2018.11 2019.01
+ Marek Vasut &lt;marek.vasut@gmail.com&gt;
+ d3689267f92c5956e09cc7d1baa4700141662bff
+ .
+ .
+ .
+ NOTE: base-passwd 3.5.29 3.5.45
+ Anuj Mittal &lt;anuj.mittal@intel.com&gt; cannot be updated due to: Version
+ 3.5.38 requires cdebconf for update-passwd utility
+ NOTE: busybox 1.29.2 1.30.0
+ Andrej Valek &lt;andrej.valek@siemens.com&gt;
+ NOTE: dbus-test 1.12.10 1.12.12
+ Chen Qi &lt;Qi.Chen@windriver.com&gt;
+ </literallayout>
+ </para>
+ </section>
+
<section id='devtool-upgrading-a-recipe'>
<title>Upgrading a Recipe</title>
@@ -441,6 +506,13 @@
section of the Yocto Project Development Tasks Manual.
This section overviews the <filename>devtool upgrade</filename>
command.
+ <note>
+ Before you upgrade a recipe, you can check on its upgrade
+ status.
+ See the
+ "<link linkend='devtool-checking-on-the-upgrade-status-of-a-recipe'>Checking on the Upgrade Status of a Recipe</link>"
+ for more information.
+ </note>
</para>
<para>