mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-06-01 00:59:48 +00:00
Code Issues Projects Releases Wiki Activity

sdk-manual: Changes to the devtool upgrade section.

Browse Source 
Edits to improve this section.

(From yocto-docs rev: af0084dd82b7dcec73db5a1b4e6760b7b7738bf9)

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-05-30 15:15:59 -07:00
committed by Richard Purdie
parent 1b8867ad08
commit 12c05ab1b0
1 changed files with 52 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/sdk-manual/sdk-extensible.xml
+52 -29
View File
@@ -708,9 +708,25 @@
your source code modifications. your source code modifications.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<emphasis>Build the Recipe</emphasis>: <emphasis>Build the Recipe or Rebuild the Image</emphasis>:
Once you have updated the source files, you can build The next step you take depends on what you are going
the recipe. to do with the new code.</para>
<para>If you need to eventually move the build output
to the target hardware, use the following
<filename>devtool</filename> command:
<literallayout class='monospaced'>
$ devtool build <replaceable>recipe</replaceable>
</literallayout></para>
<para>On the other hand, if you want an image to
contain the recipe's packages from the workspace
for immediate deployment onto a device (e.g. for
testing purposes), you can use
the <filename>devtool build-image</filename> command:
<literallayout class='monospaced'>
$ devtool build-image <replaceable>image</replaceable>
</literallayout>
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<emphasis>Deploy the Build Output</emphasis>: <emphasis>Deploy the Build Output</emphasis>:
@@ -800,7 +816,7 @@
workflow to make sure your recipes you are using for builds workflow to make sure your recipes you are using for builds
are up-to-date with their upstream counterparts. are up-to-date with their upstream counterparts.
<note> <note>
Several methods exist by which you can upgrade recipes. Several methods exist by which you can upgrade recipes -
<filename>devtool upgrade</filename> happens to be one. <filename>devtool upgrade</filename> happens to be one.
You can read about all the methods by which you can You can read about all the methods by which you can
upgrade recipes in the upgrade recipes in the
@@ -819,12 +835,8 @@
</para> </para>
<para> <para>
Depending on your particular scenario, the arguments and The following diagram shows the common development flow
options you use with <filename>devtool upgrade</filename> form used with the <filename>devtool upgrade</filename> command:
different combinations.
The following diagram shows a common development flow
you would use with the <filename>devtool upgrade</filename>
command:
</para> </para>
<para> <para>
@@ -835,19 +847,18 @@
<orderedlist> <orderedlist>
<listitem><para> <listitem><para>
<emphasis>Initiate the Upgrade</emphasis>: <emphasis>Initiate the Upgrade</emphasis>:
The top part of the flow shows a typical scenario by The top part of the flow shows the typical scenario by
which you could use which you use the <filename>devtool upgrade</filename>
<filename>devtool upgrade</filename>. command.
The following conditions exist: The following conditions exist:
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
The recipe exists in some layer external The recipe exists in a local layer external
to the <filename>devtool</filename> workspace. to the <filename>devtool</filename> workspace.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
The source files for the new release The source files for the new release
exist adjacent to the same location pointed to exist in the same location pointed to by
by
<ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
in the recipe (e.g. a tarball with the new in the recipe (e.g. a tarball with the new
version number in the name, or as a different version number in the name, or as a different
@@ -888,19 +899,19 @@
<para>Once <filename>devtool</filename> locates the <para>Once <filename>devtool</filename> locates the
recipe, it uses the <filename>SRC_URI</filename> recipe, it uses the <filename>SRC_URI</filename>
variable to locate the source code and any local patch variable to locate the source code and any local patch
files from other developers are located. files from other developers.
The result is that the command sets up the source The result is that the command sets up the source
code, the new version of the recipe, and an append file code, the new version of the recipe, and an append file
all within the workspace. all within the workspace.
</para></listitem> </para></listitem>
<listitem><para><emphasis> <listitem><para>
Resolve any Conflicts created by the Upgrade</emphasis>: <emphasis>Resolve any Conflicts created by the Upgrade</emphasis>:
At this point, conflicts could exist due to the Conflicts could exist due to the software being
software being upgraded to a new version. upgraded to a new version.
Conflicts occur if your recipe specifies some patch Conflicts occur if your recipe specifies some patch
files in <filename>SRC_URI</filename> that conflict files in <filename>SRC_URI</filename> that conflict
with changes made in the new version of the software. with changes made in the new version of the software.
If this is the case, you need to resolve the conflicts For such cases, you need to resolve the conflicts
by editing the source and following the normal by editing the source and following the normal
<filename>git rebase</filename> conflict resolution <filename>git rebase</filename> conflict resolution
process.</para> process.</para>
@@ -910,13 +921,25 @@
newer or different version of the software. newer or different version of the software.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<emphasis>Build the Recipe</emphasis>: <emphasis>Build the Recipe or Rebuild the Image</emphasis>:
Once you have your recipe in order, you can build it. The next step you take depends on what you are going
You can either use <filename>devtool build</filename> to do with the new code.</para>
or <filename>bitbake</filename>.
Either method produces build output that is stored <para>If you need to eventually move the build output
in to the target hardware, use the following
<ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink>. <filename>devtool</filename> command:
<literallayout class='monospaced'>
$ devtool build <replaceable>recipe</replaceable>
</literallayout></para>
<para>On the other hand, if you want an image to
contain the recipe's packages from the workspace
for immediate deployment onto a device (e.g. for
testing purposes), you can use
the <filename>devtool build-image</filename> command:
<literallayout class='monospaced'>
$ devtool build-image <replaceable>image</replaceable>
</literallayout>
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<emphasis>Deploy the Build Output</emphasis>: <emphasis>Deploy the Build Output</emphasis>: