summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-devtool-reference.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-03-06 12:52:00 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-03-25 09:41:11 +0100
commit51347f576af4ac4a959c282ddd4d86fdb3cd606d (patch)
tree305b8d00fbf587d3f5da317a04740832a1f2ea3c /documentation/ref-manual/ref-devtool-reference.xml
parent47e92cd7539a56a25b8d757f6707df5608d2c0ac (diff)
downloadpoky-51347f576af4ac4a959c282ddd4d86fdb3cd606d.tar.gz
ref-manual: Updated the section on devtool upgrade
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>
Diffstat (limited to 'documentation/ref-manual/ref-devtool-reference.xml')
-rw-r--r--documentation/ref-manual/ref-devtool-reference.xml41
1 files changed, 34 insertions, 7 deletions
diff --git a/documentation/ref-manual/ref-devtool-reference.xml b/documentation/ref-manual/ref-devtool-reference.xml
index e29bf89e51..e4d27bfe50 100644
--- a/documentation/ref-manual/ref-devtool-reference.xml
+++ b/documentation/ref-manual/ref-devtool-reference.xml
@@ -426,12 +426,27 @@
426 <title>Upgrading a Recipe</title> 426 <title>Upgrading a Recipe</title>
427 427
428 <para> 428 <para>
429 Use the <filename>devtool upgrade</filename> command 429 As software matures, upstream recipes are upgraded to newer
430 to upgrade an existing recipe to a new upstream version. 430 versions.
431 The command puts the upgraded recipe file into the 431 As a developer, you need to keep your local recipes up-to-date
432 workspace along with any associated files, and extracts 432 with the upstream version releases.
433 the source tree to a specified location should patches 433 Several methods exist by which you can upgrade recipes.
434 need rebased or added to as a result of the upgrade. 434 You can read about them in the
435 "<ulink url='&YOCTO_DOCS_DEV_URL;#gs-upgrading-recipes'>Upgrading Recipes</ulink>"
436 section of the Yocto Project Development Tasks Manual.
437 This section overviews the <filename>devtool upgrade</filename>
438 command.
439 </para>
440
441 <para>
442 The <filename>devtool upgrade</filename> command
443 upgrades an existing recipe to a more recent version of the
444 recipe upstream.
445 The command puts the upgraded recipe file along with any associated
446 files into a "workspace" and, if necessary, extracts the source
447 tree to a specified location.
448 During the upgrade, patches associated with the recipe are
449 rebased or added as needed.
435 </para> 450 </para>
436 451
437 <para> 452 <para>
@@ -443,9 +458,21 @@
443 the version number to which you want to upgrade (i.e. the 458 the version number to which you want to upgrade (i.e. the
444 <link linkend='var-PV'><filename>PV</filename></link>), 459 <link linkend='var-PV'><filename>PV</filename></link>),
445 the source revision to which you want to upgrade (i.e. the 460 the source revision to which you want to upgrade (i.e. the
446 <link linkend='var-SRCREV'><filename>SRCREV</filename></link>, 461 <link linkend='var-SRCREV'><filename>SRCREV</filename></link>),
447 whether or not to apply patches, and so forth. 462 whether or not to apply patches, and so forth.
448 </para> 463 </para>
464
465 <para>
466 You can read more on the <filename>devtool upgrade</filename>
467 workflow in the
468 "<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>"
469 section in the Yocto Project Application Development and the
470 Extensible Software Development Kit (eSDK) Manual.
471 You can also see an example of how to use
472 <filename>devtool upgrade</filename> in the
473 "<ulink url='&YOCTO_DOCS_DEV_URL;#gs-using-devtool-upgrade'>Using <filename>devtool upgrade</filename></ulink>"
474 section in the Yocto Project Development Tasks Manual.
475 </para>
449 </section> 476 </section>
450 477
451 <section id='devtool-resetting-a-recipe'> 478 <section id='devtool-resetting-a-recipe'>