From 25efbee1d7120d2362698811b53320ba81b9d4aa Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 25 Jun 2019 12:50:14 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/sdk-manual/sdk-extensible.xml | 85 +++++++++++++++++++++++++---- 1 file changed, 73 insertions(+), 12 deletions(-) (limited to 'documentation') 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. + + Additionally, if you have any non-patch + local files (i.e. files referred to with + file:// entries in + SRC_URI statement excluding + *.patch/ or + *.diff), these files are + copied to an + oe-local-files 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. Middle: @@ -633,10 +649,10 @@ The following command tells - devtool what recipe with + devtool 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 devtool workspace: $ devtool modify recipe srctree @@ -650,8 +666,12 @@ the recipe's SRC_URI 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 + oe-local-files folder + under the newly created source tree. + + Once the files are located, the command + by default extracts them into srctree. Within workspace, @@ -685,9 +705,21 @@ - Once the command finishes, it creates only - an append file for the recipe in the - devtool workspace. + If an oe-local-files + 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 devtool finish + command, any non-patch files that might exist + next to the recipe are removed because it + appears to devtool that + you have deleted those files. + + Once the + devtool modify command + finishes, it creates only an append file for + the recipe in the devtool + workspace. The recipe and the source code remain in their original locations. @@ -778,7 +810,12 @@ original recipe in the original layer or the command creates a .bbappend file in a different layer as provided by - layer. + layer. + Any work you did in the + oe-local-files directory is + preserved in the original files next to the recipe + during the devtool finish + command. As a final process of the devtool finish 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. + + Additionally, if you have any non-patch + local files (i.e. files referred to with + file:// entries in + SRC_URI statement excluding + *.patch/ or + *.diff), these files are + copied to an + oe-local-files 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. Resolve any Conflicts created by the Upgrade: @@ -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. + + Any work you did in the + oe-local-files directory is + preserved in the original files next to the recipe + during the devtool finish + command. + + 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. $ devtool finish recipe layer -- cgit v1.2.3-54-g00ecf