mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-04-03 20:02:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: Updated the section on devtool upgrade

Browse Source 
Provided a bit of rationale on why and when you use this command.
Put in several links to help the reader get to related areas where
command use is explained.

(From yocto-docs rev: 7b30f29bfa15dd15f1388bb856e2047be55e7fb9)

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-06 12:52:00 -08:00
committed by Richard Purdie
parent 47e92cd753
commit 51347f576a
1 changed files with 34 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
documentation/ref-manual/ref-devtool-reference.xml
View File

@@ -426,12 +426,27 @@
<title>Upgrading a Recipe</title>
<para>
Use the <filename>devtool upgrade</filename> command
to upgrade an existing recipe to a new upstream version.
The command puts the upgraded recipe file into the
workspace along with any associated files, and extracts
the source tree to a specified location should patches
need rebased or added to as a result of the upgrade.
As software matures, upstream recipes are upgraded to newer
versions.
As a developer, you need to keep your local recipes up-to-date
with the upstream version releases.
Several methods exist by which you can upgrade recipes.
You can read about them in the
"<ulink url='&YOCTO_DOCS_DEV_URL;#gs-upgrading-recipes'>Upgrading Recipes</ulink>"
section of the Yocto Project Development Tasks Manual.
This section overviews the <filename>devtool upgrade</filename>
command.
</para>
<para>
The <filename>devtool upgrade</filename> command
upgrades an existing recipe to a more recent version of the
recipe upstream.
The command puts the upgraded recipe file along with any associated
files into a "workspace" and, if necessary, extracts the source
tree to a specified location.
During the upgrade, patches associated with the recipe are
rebased or added as needed.
</para>
<para>
@@ -443,9 +458,21 @@
the version number to which you want to upgrade (i.e. the
<link linkend='var-PV'><filename>PV</filename></link>),
the source revision to which you want to upgrade (i.e. the
<link linkend='var-SRCREV'><filename>SRCREV</filename></link>,
<link linkend='var-SRCREV'><filename>SRCREV</filename></link>),
whether or not to apply patches, and so forth.
</para>
<para>
You can read more on the <filename>devtool upgrade</filename>
workflow in the
"<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-devtool-use-devtool-upgrade-to-create-a-version-of-the-recipe-that-supports-a-newer-version-of-the-software'>Use <filename>devtool upgrade</filename> to Create a Version of the Recipe that Supports a Newer Version of the Software</ulink>"
section in the Yocto Project Application Development and the
Extensible Software Development Kit (eSDK) Manual.
You can also see an example of how to use
<filename>devtool upgrade</filename> in the
"<ulink url='&YOCTO_DOCS_DEV_URL;#gs-using-devtool-upgrade'>Using <filename>devtool upgrade</filename></ulink>"
section in the Yocto Project Development Tasks Manual.
</para>
</section>
<section id='devtool-resetting-a-recipe'>