From e68171d8064387769175bfc2bf9d3aaec6805e59 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Thu, 30 May 2019 10:12:03 -0700
Subject: 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>
---
 documentation/ref-manual/ref-devtool-reference.xml | 49 +++++++++++++++++++---
 1 file changed, 43 insertions(+), 6 deletions(-)

(limited to 'documentation')

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 @@
         </para>
     </section>
 
-
     <section id='devtool-checking-on-the-upgrade-status-of-a-recipe'>
         <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
             <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.
+            the latest upstream versions, the email address of the recipe's
+            maintainer, and any additional information such as commit hash
+            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>
@@ -465,8 +481,29 @@
       -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:
+        </para>
+
+        <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'>
      $ devtool check-upgrade-status
          ...
-- 
cgit v1.2.3-54-g00ecf