summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-model.xml69
-rw-r--r--documentation/dev-manual/figures/devtool-upgrade-flow.pngbin140597 -> 139827 bytes
2 files changed, 34 insertions, 35 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index dcff37e981..0385fac44c 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -1217,43 +1217,42 @@
1217 However, <filename>devtool</filename> does not provide a 1217 However, <filename>devtool</filename> does not provide a
1218 specific command that allows you to do this. 1218 specific command that allows you to do this.
1219 </para></listitem> 1219 </para></listitem>
1220 <listitem><para><emphasis>Optionally Create Patch Files for Your Changes</emphasis>: 1220 <listitem><para>
1221 After you have debugged your changes, you can 1221 <emphasis>Finish Your Work With the Recipe</emphasis>:
1222 use <filename>devtool update-recipe</filename> to 1222 The <filename>devtool finish</filename> command creates
1223 generate patch files for all the commits you have 1223 any patches corresponding to commits in the local
1224 made. 1224 Git repository, updates the recipe to point to them
1225 <note> 1225 (or creates a <filename>.bbappend</filename> file to do
1226 Patch files are generated only for changes 1226 so, depending on the specified destination layer), and
1227 you have committed. 1227 then resets the recipe so that the recipe is built normally
1228 </note> 1228 rather than from the workspace.
1229 <literallayout class='monospaced'>
1230 $ devtool update-recipe <replaceable>recipe</replaceable>
1231 </literallayout>
1232 By default, the
1233 <filename>devtool update-recipe</filename> command
1234 creates the patch files in a folder named the same
1235 as the recipe beneath the folder in which the recipe
1236 resides, and updates the recipe's
1237 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
1238 statement to point to the generated patch files.
1239 </para></listitem>
1240 <listitem><para><emphasis>Move the Recipe to its Permanent Layer</emphasis>:
1241 Before cleaning up the workspace, you need to move the
1242 final recipe to its permanent layer.
1243 You can either overwrite the original recipe or you can
1244 overlay the upgraded recipe into a separate layer.
1245 You must do this before using the
1246 <filename>devtool reset</filename> command if you want to
1247 retain the upgraded recipe.
1248 </para></listitem>
1249 <listitem><para><emphasis>Restore the Workspace</emphasis>:
1250 The <filename>devtool reset</filename> restores the
1251 state so that standard layers and upstream sources are
1252 used to build the recipe rather than what is in the
1253 workspace.
1254 <literallayout class='monospaced'> 1229 <literallayout class='monospaced'>
1255 $ devtool reset <replaceable>recipe</replaceable> 1230 $ devtool finish <replaceable>recipe layer</replaceable>
1256 </literallayout> 1231 </literallayout>
1232 <note>
1233 Any changes you want to turn into patches must be
1234 committed to the Git repository in the source tree.
1235 </note></para>
1236
1237 <para>Because there is no need to move the recipe,
1238 <filename>devtool finish</filename> either updates the
1239 original recipe in the original layer or the command
1240 creates a <filename>.bbappend</filename> in a different
1241 layer as provided by <replaceable>layer</replaceable>.
1242 </para>
1243
1244 <para>As a final process of the
1245 <filename>devtool finish</filename> command, the state
1246 of the standard layers and the upstream source is
1247 restored so that you can build the recipe from those
1248 areas rather than the workspace.
1249 <note>
1250 You can use the <filename>devtool reset</filename>
1251 command to put things back should you decide you
1252 do not want to proceed with your work.
1253 If you do use this command, realize that the source
1254 tree is preserved.
1255 </note>
1257 </para></listitem> 1256 </para></listitem>
1258 </orderedlist> 1257 </orderedlist>
1259 </para> 1258 </para>
diff --git a/documentation/dev-manual/figures/devtool-upgrade-flow.png b/documentation/dev-manual/figures/devtool-upgrade-flow.png
index d25168c840..65474dad02 100644
--- a/documentation/dev-manual/figures/devtool-upgrade-flow.png
+++ b/documentation/dev-manual/figures/devtool-upgrade-flow.png
Binary files differ