From b2a68067f5aab3cd0f0f56ac04af59009a234284 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 29 Jan 2015 06:48:05 -0800 Subject: [PATCH] dev-manual: Edits to Quilt and finding temporary source code sections These edits help place the two sections within the new organization that basically splits out the devtool and quilt methods as ways of modifying your source code. (From yocto-docs rev: 1dc2e8783d9774bb98a30e06d114f1c9bfb85b71) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-model.xml | 59 ++++++++++--------- 1 file changed, 32 insertions(+), 27 deletions(-) diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 15b815d417..f2f859b94a 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -2264,20 +2264,23 @@ Quilt is a powerful tool that allows you to capture source code changes without having a clean source tree. - This section outlines the typical workflow you can use to modify temporary source code, - test changes, and then preserve the changes in the form of a patch all using Quilt. + This section outlines the typical workflow you can use to modify + source code, test changes, and then preserve the changes in the + form of a patch all using Quilt. Follow these general steps: Find the Source Code: - The temporary source code used by the OpenEmbedded build system is kept in the - Build Directory. + Temporary source code used by the OpenEmbedded build system + is kept in the + Build Directory. See the "Finding Temporary Source Code" - section to learn how to locate the directory that has the temporary source code for a - particular package. + section to learn how to locate the directory that has the + temporary source code for a particular package. + Change Your Working Directory: You need to be in the directory that has the temporary source code. That directory is defined by the @@ -2298,15 +2301,16 @@ Edit the Files: - Make your changes in the temporary source code to the files you added - to the patch. + Make your changes in the source code to the files you added + to the patch. + Test Your Changes: Once you have modified the source code, the easiest way to your changes is by calling the do_compile task as shown in the following example: - $ bitbake -c compile -f name_of_package + $ bitbake -c compile -f package The -f or ‐‐force option forces the specified task to execute. @@ -2318,9 +2322,9 @@ or do_cleanall tasks using BitBake (i.e. - bitbake -c clean name_of_package + bitbake -c clean package and - bitbake -c cleanall name_of_package). + bitbake -c cleanall package). Modifications will also disappear if you use the rm_work feature as described in the "Building an Image" @@ -2363,20 +2367,19 @@ Finding Temporary Source Code - You might - find it helpful during development to modify the temporary source code used by recipes - to build packages. - For example, suppose you are developing a patch and you need to experiment a bit - to figure out your solution. - After you have initially built the package, you can iteratively tweak the - source code, which is located in the + You might find it helpful during development to modify the + temporary source code used by recipes to build packages. + For example, suppose you are developing a patch and you need to + experiment a bit to figure out your solution. + After you have initially built the package, you can iteratively + tweak the source code, which is located in the Build Directory, and then you can force a re-compile and quickly test your altered code. - Once you settle on a solution, you can then preserve your changes in the form of - patches. - You can accomplish these steps all within either a - Quilt or - Git workflow. + Once you settle on a solution, you can then preserve your changes + in the form of patches. + If you are using Quilt for development, see the + "Using Quilt in Your Workflow" + section for more information. @@ -2432,7 +2435,7 @@ As an example, assume a Source Directory top-level folder - name poky, a default Build Directory at + named poky, a default Build Directory at poky/build, and a qemux86-poky-linux machine target system. @@ -2446,9 +2449,11 @@ - Now that you know where to locate the directory that has the temporary source code, - you can use a Quilt or Git workflow to make your edits, test the changes, - and preserve the changes in the form of patches. + Now that you know where to locate the directory that has the + temporary source code, you can use a Quilt as described in section + "Using Quilt in Your Workflow" + to make your edits, test the changes, and preserve the changes in + the form of patches.