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>
This commit is contained in:
Scott Rifenbark
2018-03-07 12:38:12 -08:00
committed by Richard Purdie
parent cfe25e8410
commit 4ae67cc01a

View File

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