diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2019-06-25 12:50:14 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2019-07-18 12:16:53 +0100 |
commit | 25efbee1d7120d2362698811b53320ba81b9d4aa (patch) | |
tree | 02bf1addf5f36b921ef739ee9d65a053b14a0b0e | |
parent | f3c76f8fd6b6006894614abfa4bd09f846c9d538 (diff) | |
download | openembedded-core-contrib-25efbee1d7120d2362698811b53320ba81b9d4aa.tar.gz |
sdk-manual: Updated devtool to talk about oe-local-files.
Fixes YOCTO #13079
Bug is about making sure the section on the devtool command
talks about oe-local-files. Two devtool commands (modify
and upgrade) needed to mention the role of the oe-local-files
area and how it is used during these commands. I updated the
appropriate sections:
* Use devtool modify to Modify the Source of an Existing Component
* Use devtool upgrade to Create a Version of the Recipe that
Supports a Newer Version of the Software.
(From yocto-docs rev: 70ed68eca6dcb5b1f1b5638fd27a7b513b65661e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/sdk-manual/sdk-extensible.xml | 85 |
1 files changed, 73 insertions, 12 deletions
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml index bd5278493f..94d2a241fe 100644 --- a/documentation/sdk-manual/sdk-extensible.xml +++ b/documentation/sdk-manual/sdk-extensible.xml @@ -618,7 +618,23 @@ The result is that the command sets up both the source code and an append file within the workspace while the recipe remains in its - original location. + original location.</para> + + <para>Additionally, if you have any non-patch + local files (i.e. files referred to with + <filename>file://</filename> entries in + <filename>SRC_URI</filename> statement excluding + <filename>*.patch/</filename> or + <filename>*.diff</filename>), these files are + copied to an + <filename>oe-local-files</filename> folder + under the newly created source tree. + Copying the files here gives you a convenient + area from which you can modify the files. + Any changes or additions you make to those + files are incorporated into the build the next + time you build the software just as are other + changes you might have made to the source. </para></listitem> <listitem><para> <emphasis>Middle</emphasis>: @@ -633,10 +649,10 @@ </para> <para>The following command tells - <filename>devtool</filename> what recipe with + <filename>devtool</filename> the recipe with which to work and, in this case, identifies a local area for the extracted source files that - is outside of the default + exists outside of the default <filename>devtool</filename> workspace: <literallayout class='monospaced'> $ devtool modify <replaceable>recipe srctree</replaceable> @@ -650,8 +666,12 @@ the recipe's <filename>SRC_URI</filename> statements to locate the source files and any associated patch files. - Once the files are located, the command by - default extracts them into + Non-patch files are copied to an + <filename>oe-local-files</filename> folder + under the newly created source tree.</para> + + <para>Once the files are located, the command + by default extracts them into <replaceable>srctree</replaceable>.</para> <para>Within workspace, @@ -685,9 +705,21 @@ </literallayout> </para> - <para>Once the command finishes, it creates only - an append file for the recipe in the - <filename>devtool</filename> workspace. + <para>If an <filename>oe-local-files</filename> + subdirectory happens to exist and it contains + non-patch files, the files are used. + However, if the subdirectory does not exist and + you run the <filename>devtool finish</filename> + command, any non-patch files that might exist + next to the recipe are removed because it + appears to <filename>devtool</filename> that + you have deleted those files.</para> + + <para>Once the + <filename>devtool modify</filename> command + finishes, it creates only an append file for + the recipe in the <filename>devtool</filename> + workspace. The recipe and the source code remain in their original locations. </para></listitem> @@ -778,7 +810,12 @@ original recipe in the original layer or the command creates a <filename>.bbappend</filename> file in a different layer as provided by - <replaceable>layer</replaceable>.</para> + <replaceable>layer</replaceable>. + Any work you did in the + <filename>oe-local-files</filename> directory is + preserved in the original files next to the recipe + during the <filename>devtool finish</filename> + command.</para> <para>As a final process of the <filename>devtool finish</filename> command, the state @@ -898,7 +935,23 @@ files from other developers. The result is that the command sets up the source code, the new version of the recipe, and an append file - all within the workspace. + all within the workspace.</para> + + <para>Additionally, if you have any non-patch + local files (i.e. files referred to with + <filename>file://</filename> entries in + <filename>SRC_URI</filename> statement excluding + <filename>*.patch/</filename> or + <filename>*.diff</filename>), these files are + copied to an + <filename>oe-local-files</filename> folder + under the newly created source tree. + Copying the files here gives you a convenient + area from which you can modify the files. + Any changes or additions you make to those + files are incorporated into the build the next + time you build the software just as are other + changes you might have made to the source. </para></listitem> <listitem><para> <emphasis>Resolve any Conflicts created by the Upgrade</emphasis>: @@ -976,10 +1029,18 @@ Git repository, moves the new recipe to a more permanent layer, and then resets the recipe so that the recipe is built normally rather than from the - workspace. + workspace.</para> + + <para>Any work you did in the + <filename>oe-local-files</filename> directory is + preserved in the original files next to the recipe + during the <filename>devtool finish</filename> + command.</para> + + <para> If you specify a destination layer that is the same as the original source, then the old version of the - recipe and associated files will be removed prior to + recipe and associated files are removed prior to adding the new version. <literallayout class='monospaced'> $ devtool finish <replaceable>recipe layer</replaceable> |