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 @@ Upgrading a Recipe - Use the devtool upgrade 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 + "Upgrading Recipes" + section of the Yocto Project Development Tasks Manual. + This section overviews the devtool upgrade + command. + + + + The devtool upgrade 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. @@ -443,9 +458,21 @@ the version number to which you want to upgrade (i.e. the PV), the source revision to which you want to upgrade (i.e. the - SRCREV, + SRCREV), whether or not to apply patches, and so forth. + + + You can read more on the devtool upgrade + workflow in the + "Use devtool upgrade to Create a Version of the Recipe that Supports a Newer Version of the Software" + 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 + devtool upgrade in the + "Using devtool upgrade" + section in the Yocto Project Development Tasks Manual. +