From 4ae67cc01a5ac05526fe934aa4c8d756200ab5f3 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Wed, 7 Mar 2018 12:38:12 -0800
Subject: dev-manual: Review edits to manual upgrades for recipes.

(From yocto-docs rev: 05307788395cb16af95e89592bda070be6c1a397)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../dev-manual/dev-manual-common-tasks.xml         | 29 ++++++++++++++--------
 1 file changed, 18 insertions(+), 11 deletions(-)

(limited to 'documentation/dev-manual')

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 306ba6d580..e70d62f5c4 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -4541,17 +4541,18 @@
                 To manually upgrade recipe versions, follow these general steps:
                 <orderedlist>
                     <listitem><para>
-                        <emphasis>Change the Recipe Name:</emphasis>
-                        Adjust the version (i.e.
-                        <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>)
-                        part of the recipe name such that it uses the
-                        new version number.
+                        <emphasis>Change the Version:</emphasis>
+                        Rename the recipe such that the version (i.e. the
+                        <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>
+                        part of the recipe name) changes appropriately.
+                        If the version is not part of the recipe name, change
+                        the value as it is set for <filename>PV</filename>
+                        within the recipe itself.
                         </para></listitem>
                     <listitem><para>
                         <emphasis>Update <filename>SRCREV</filename> if Needed:</emphasis>
                         If the source code your recipe builds is fetched from
-                        Git or some other Version Control System (VCS),
-                        update
+                        Git or some other version control system, update
                         <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink>
                         to point to the commit hash that matches the new
                         version.
@@ -4562,13 +4563,19 @@
                         Typical build failures include the following:
                         <itemizedlist>
                             <listitem><para>
-                                License terms were updated for the new version.
-                                For this case, you need to review the new
-                                terms of the license and update the values of
+                                License statements were updated for the new
+                                version.
+                                For this case, you need to review any changes
+                                to the license and update the values of
                                 <ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE'><filename>LICENSE</filename></ulink>
                                 and
                                 <ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></ulink>
                                 as needed.
+                                <note>
+                                    License changes are often inconsequential.
+                                    For example, the license text's copyright
+                                    year might have changed.
+                                </note>
                                 </para></listitem>
                             <listitem><para>
                                 Custom patches carried by the older version of
@@ -4592,7 +4599,7 @@
                         <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
                         variable and rebuilding the software.
                         This optional step is especially important if the
-                        recipe is public.
+                        recipe is to be released publicly.
                         </para></listitem>
                     <listitem><para>
                         <emphasis>Check the Upstream Change Log or Release Notes:</emphasis>
-- 
cgit v1.2.3-54-g00ecf