diff options
-rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 59 |
1 files 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 @@ | |||
2264 | <ulink url='http://savannah.nongnu.org/projects/quilt'>Quilt</ulink> | 2264 | <ulink url='http://savannah.nongnu.org/projects/quilt'>Quilt</ulink> |
2265 | is a powerful tool that allows you to capture source code changes without having | 2265 | is a powerful tool that allows you to capture source code changes without having |
2266 | a clean source tree. | 2266 | a clean source tree. |
2267 | This section outlines the typical workflow you can use to modify temporary source code, | 2267 | This section outlines the typical workflow you can use to modify |
2268 | test changes, and then preserve the changes in the form of a patch all using Quilt. | 2268 | source code, test changes, and then preserve the changes in the |
2269 | form of a patch all using Quilt. | ||
2269 | </para> | 2270 | </para> |
2270 | 2271 | ||
2271 | <para> | 2272 | <para> |
2272 | Follow these general steps: | 2273 | Follow these general steps: |
2273 | <orderedlist> | 2274 | <orderedlist> |
2274 | <listitem><para><emphasis>Find the Source Code:</emphasis> | 2275 | <listitem><para><emphasis>Find the Source Code:</emphasis> |
2275 | The temporary source code used by the OpenEmbedded build system is kept in the | 2276 | Temporary source code used by the OpenEmbedded build system |
2276 | Build Directory. | 2277 | is kept in the |
2278 | <link linkend='build-directory'>Build Directory</link>. | ||
2277 | See the | 2279 | See the |
2278 | "<link linkend='finding-the-temporary-source-code'>Finding Temporary Source Code</link>" | 2280 | "<link linkend='finding-the-temporary-source-code'>Finding Temporary Source Code</link>" |
2279 | section to learn how to locate the directory that has the temporary source code for a | 2281 | section to learn how to locate the directory that has the |
2280 | particular package.</para></listitem> | 2282 | temporary source code for a particular package. |
2283 | </para></listitem> | ||
2281 | <listitem><para><emphasis>Change Your Working Directory:</emphasis> | 2284 | <listitem><para><emphasis>Change Your Working Directory:</emphasis> |
2282 | You need to be in the directory that has the temporary source code. | 2285 | You need to be in the directory that has the temporary source code. |
2283 | That directory is defined by the | 2286 | That directory is defined by the |
@@ -2298,15 +2301,16 @@ | |||
2298 | </literallayout> | 2301 | </literallayout> |
2299 | </para></listitem> | 2302 | </para></listitem> |
2300 | <listitem><para><emphasis>Edit the Files:</emphasis> | 2303 | <listitem><para><emphasis>Edit the Files:</emphasis> |
2301 | Make your changes in the temporary source code to the files you added | 2304 | Make your changes in the source code to the files you added |
2302 | to the patch.</para></listitem> | 2305 | to the patch. |
2306 | </para></listitem> | ||
2303 | <listitem><para><emphasis>Test Your Changes:</emphasis> | 2307 | <listitem><para><emphasis>Test Your Changes:</emphasis> |
2304 | Once you have modified the source code, the easiest way to | 2308 | Once you have modified the source code, the easiest way to |
2305 | your changes is by calling the | 2309 | your changes is by calling the |
2306 | <filename>do_compile</filename> task as shown in the | 2310 | <filename>do_compile</filename> task as shown in the |
2307 | following example: | 2311 | following example: |
2308 | <literallayout class='monospaced'> | 2312 | <literallayout class='monospaced'> |
2309 | $ bitbake -c compile -f <replaceable>name_of_package</replaceable> | 2313 | $ bitbake -c compile -f <replaceable>package</replaceable> |
2310 | </literallayout> | 2314 | </literallayout> |
2311 | The <filename>-f</filename> or <filename>‐‐force</filename> | 2315 | The <filename>-f</filename> or <filename>‐‐force</filename> |
2312 | option forces the specified task to execute. | 2316 | option forces the specified task to execute. |
@@ -2318,9 +2322,9 @@ | |||
2318 | or | 2322 | or |
2319 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleanall'><filename>do_cleanall</filename></ulink> | 2323 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleanall'><filename>do_cleanall</filename></ulink> |
2320 | tasks using BitBake (i.e. | 2324 | tasks using BitBake (i.e. |
2321 | <filename>bitbake -c clean <replaceable>name_of_package</replaceable></filename> | 2325 | <filename>bitbake -c clean <replaceable>package</replaceable></filename> |
2322 | and | 2326 | and |
2323 | <filename>bitbake -c cleanall <replaceable>name_of_package</replaceable></filename>). | 2327 | <filename>bitbake -c cleanall <replaceable>package</replaceable></filename>). |
2324 | Modifications will also disappear if you use the <filename>rm_work</filename> | 2328 | Modifications will also disappear if you use the <filename>rm_work</filename> |
2325 | feature as described in the | 2329 | feature as described in the |
2326 | "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" | 2330 | "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" |
@@ -2363,20 +2367,19 @@ | |||
2363 | <title>Finding Temporary Source Code</title> | 2367 | <title>Finding Temporary Source Code</title> |
2364 | 2368 | ||
2365 | <para> | 2369 | <para> |
2366 | You might | 2370 | You might find it helpful during development to modify the |
2367 | find it helpful during development to modify the temporary source code used by recipes | 2371 | temporary source code used by recipes to build packages. |
2368 | to build packages. | 2372 | For example, suppose you are developing a patch and you need to |
2369 | For example, suppose you are developing a patch and you need to experiment a bit | 2373 | experiment a bit to figure out your solution. |
2370 | to figure out your solution. | 2374 | After you have initially built the package, you can iteratively |
2371 | After you have initially built the package, you can iteratively tweak the | 2375 | tweak the source code, which is located in the |
2372 | source code, which is located in the | ||
2373 | <link linkend='build-directory'>Build Directory</link>, and then | 2376 | <link linkend='build-directory'>Build Directory</link>, and then |
2374 | you can force a re-compile and quickly test your altered code. | 2377 | you can force a re-compile and quickly test your altered code. |
2375 | Once you settle on a solution, you can then preserve your changes in the form of | 2378 | Once you settle on a solution, you can then preserve your changes |
2376 | patches. | 2379 | in the form of patches. |
2377 | You can accomplish these steps all within either a | 2380 | If you are using Quilt for development, see the |
2378 | <ulink url='http://savannah.nongnu.org/projects/quilt'>Quilt</ulink> or | 2381 | "<link linkend='using-a-quilt-workflow'>Using Quilt in Your Workflow</link>" |
2379 | <link linkend='git'>Git</link> workflow. | 2382 | section for more information. |
2380 | </para> | 2383 | </para> |
2381 | 2384 | ||
2382 | <para> | 2385 | <para> |
@@ -2432,7 +2435,7 @@ | |||
2432 | 2435 | ||
2433 | <para> | 2436 | <para> |
2434 | As an example, assume a Source Directory top-level folder | 2437 | As an example, assume a Source Directory top-level folder |
2435 | name <filename>poky</filename>, a default Build Directory at | 2438 | named <filename>poky</filename>, a default Build Directory at |
2436 | <filename>poky/build</filename>, and a | 2439 | <filename>poky/build</filename>, and a |
2437 | <filename>qemux86-poky-linux</filename> machine target | 2440 | <filename>qemux86-poky-linux</filename> machine target |
2438 | system. | 2441 | system. |
@@ -2446,9 +2449,11 @@ | |||
2446 | </para> | 2449 | </para> |
2447 | 2450 | ||
2448 | <para> | 2451 | <para> |
2449 | Now that you know where to locate the directory that has the temporary source code, | 2452 | Now that you know where to locate the directory that has the |
2450 | you can use a Quilt or Git workflow to make your edits, test the changes, | 2453 | temporary source code, you can use a Quilt as described in section |
2451 | and preserve the changes in the form of patches. | 2454 | "<link linkend='using-a-quilt-workflow'>Using Quilt in Your Workflow</link>" |
2455 | to make your edits, test the changes, and preserve the changes in | ||
2456 | the form of patches. | ||
2452 | </para> | 2457 | </para> |
2453 | </section> | 2458 | </section> |
2454 | </section> | 2459 | </section> |