From 010d19ec2ccb95201902dd034401de3d129355ff Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 8 Aug 2014 16:59:39 +0300 Subject: dev-manual: Misc edits to the model chapter (Chapter 4). I replaced user-supplied variables with tags to get proper formatting. I inserted several references to the new QEMU chapter for help using QEMU. I updated a note on the BSP available so that it is a bit more generic and not so dependent on an exact list within meta-intel and the source repositories. (From yocto-docs rev: daef4406e7c3e45dd5d98d565e519d91939f6965) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-model.xml | 48 ++++++++++++++++++--------- 1 file changed, 33 insertions(+), 15 deletions(-) (limited to 'documentation') diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index a3852c44b4..45015e4e1c 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -161,11 +161,16 @@ and edgerouter (MIPS). The recipes and configurations for these five BSPs are located and dispersed within the Source Directory. - On the other hand, BSP layers for Crown Bay, + On the other hand, the meta-intel layer + contains BSP layers for many supported BSPs (e.g. Crystal Forest, Emenlow, Fish River Island 2, Haswell, - Jasper Forest, NUC DC3217IYE, - Romley, Sugar Bay, and tlk exist in their own separate layers - within the larger meta-intel layer. + Jasper Forest, and so forth). + Aside from the BSPs in the meta-intel + layer, the + Source Repositories + contain additional BSP layers such as + meta-minnow and + meta-raspberrypi. When you set up a layer for a new BSP, you should follow a standard layout. This layout is described in the "Example Filesystem Layout" @@ -603,7 +608,11 @@ QEMU through the project's preferences. If you are not using the Eclipse IDE, then you need to deploy the application to the hardware using other methods. - Or, if you are using QEMU, you need to use that tool and load your image in for testing. + Or, if you are using QEMU, you need to use that tool and + load your image in for testing. + See the + "Using the Quick EMUlator (QEMU)" + chapter for information on using QEMU. Test and debug the application: Once your application is deployed, you need to test it. @@ -1076,7 +1085,7 @@ Build system derived toolchain, the target kernel you built will be located in the Build Directory in - tmp/deploy/images/<machine> + tmp/deploy/images/machine directory. If you selected Standalone pre-built toolchain, @@ -1244,6 +1253,11 @@ To start the QEMU emulator from within Eclipse, follow these steps: + + See the + "Using the Quick EMUlator (QEMU)" + chapter for more information on using QEMU. + Expose and select "External Tools" from the "Run" menu. @@ -1484,7 +1498,7 @@ Project Location. The Yocto project's Metadata files will be put under the directory - <project_location>/<project_name>. + project_location/project_name. If that directory does not exist, you need to check the "Clone from Yocto Git Repository" box, which would execute a git clone @@ -1627,7 +1641,11 @@ If you need to separately install and use the QEMU emulator, you can go to QEMU Home Page - to download and learn about the emulator. + to download and learn about the emulator. + You can see the + "Using the Quick EMUlator (QEMU)" + chapter for information on using QEMU within the Yocto + Project. @@ -1778,7 +1796,7 @@ do_compile task as shown in the following example: - $ bitbake -c compile -f <name_of_package> + $ bitbake -c compile -f name_of_package The -f or --force option forces the specified task to execute. @@ -1790,9 +1808,9 @@ or do_cleanall tasks using BitBake (i.e. - bitbake -c clean <name_of_package> + bitbake -c clean name_of_package and - bitbake -c cleanall <name_of_package>). + bitbake -c cleanall name_of_package). Modifications will also disappear if you use the rm_work feature as described in the "Building an Image" @@ -1883,7 +1901,7 @@ do_compile task as shown in the following example: - $ bitbake -c compile -f <name_of_package> + $ bitbake -c compile -f name_of_package The -f or --force option forces the specified task to execute. @@ -1917,11 +1935,11 @@ Once you have committed the files, you can use the git log command to see your changes: - $ git commit -m "<commit-summary-message>" + $ git commit -m "commit-summary-message" $ git log The name of the patch file created in the next step is based on your - commit-summary-message. + commit-summary-message. Generate the Patch: Once the changes are committed, use the git format-patch command to generate a patch file: @@ -1948,7 +1966,7 @@ of the recipe. Here is an example: - SRC_URI += "file://0001-<commit-summary-message>.patch" + SRC_URI += "file://0001-commit-summary-message.patch" Increment the Recipe Revision Number: Finally, don't forget to 'bump' the -- cgit 1.2.3-korg