summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-03-07 12:38:12 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-03-25 09:41:11 +0100
commit4ae67cc01a5ac05526fe934aa4c8d756200ab5f3 (patch)
treeac153bf8752919bccab61e323639544af4625aff /documentation/dev-manual
parentcfe25e8410f344759c59610d3bdb89855f6264d4 (diff)
downloadpoky-4ae67cc01a5ac05526fe934aa4c8d756200ab5f3.tar.gz
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>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml29
1 files changed, 18 insertions, 11 deletions
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 @@
4541 To manually upgrade recipe versions, follow these general steps: 4541 To manually upgrade recipe versions, follow these general steps:
4542 <orderedlist> 4542 <orderedlist>
4543 <listitem><para> 4543 <listitem><para>
4544 <emphasis>Change the Recipe Name:</emphasis> 4544 <emphasis>Change the Version:</emphasis>
4545 Adjust the version (i.e. 4545 Rename the recipe such that the version (i.e. the
4546 <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>) 4546 <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>
4547 part of the recipe name such that it uses the 4547 part of the recipe name) changes appropriately.
4548 new version number. 4548 If the version is not part of the recipe name, change
4549 the value as it is set for <filename>PV</filename>
4550 within the recipe itself.
4549 </para></listitem> 4551 </para></listitem>
4550 <listitem><para> 4552 <listitem><para>
4551 <emphasis>Update <filename>SRCREV</filename> if Needed:</emphasis> 4553 <emphasis>Update <filename>SRCREV</filename> if Needed:</emphasis>
4552 If the source code your recipe builds is fetched from 4554 If the source code your recipe builds is fetched from
4553 Git or some other Version Control System (VCS), 4555 Git or some other version control system, update
4554 update
4555 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink> 4556 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink>
4556 to point to the commit hash that matches the new 4557 to point to the commit hash that matches the new
4557 version. 4558 version.
@@ -4562,13 +4563,19 @@
4562 Typical build failures include the following: 4563 Typical build failures include the following:
4563 <itemizedlist> 4564 <itemizedlist>
4564 <listitem><para> 4565 <listitem><para>
4565 License terms were updated for the new version. 4566 License statements were updated for the new
4566 For this case, you need to review the new 4567 version.
4567 terms of the license and update the values of 4568 For this case, you need to review any changes
4569 to the license and update the values of
4568 <ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE'><filename>LICENSE</filename></ulink> 4570 <ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE'><filename>LICENSE</filename></ulink>
4569 and 4571 and
4570 <ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></ulink> 4572 <ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></ulink>
4571 as needed. 4573 as needed.
4574 <note>
4575 License changes are often inconsequential.
4576 For example, the license text's copyright
4577 year might have changed.
4578 </note>
4572 </para></listitem> 4579 </para></listitem>
4573 <listitem><para> 4580 <listitem><para>
4574 Custom patches carried by the older version of 4581 Custom patches carried by the older version of
@@ -4592,7 +4599,7 @@
4592 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> 4599 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
4593 variable and rebuilding the software. 4600 variable and rebuilding the software.
4594 This optional step is especially important if the 4601 This optional step is especially important if the
4595 recipe is public. 4602 recipe is to be released publicly.
4596 </para></listitem> 4603 </para></listitem>
4597 <listitem><para> 4604 <listitem><para>
4598 <emphasis>Check the Upstream Change Log or Release Notes:</emphasis> 4605 <emphasis>Check the Upstream Change Log or Release Notes:</emphasis>