From 30bebff0dcfdced41ace0846a8d5c3e29d57b3ef Mon Sep 17 00:00:00 2001 From: "Robert P. J. Day" Date: Mon, 11 Nov 2013 11:02:57 -0800 Subject: [PATCH] dev manual: Minor tweaks to first part of ch 5, dev-manual. given the length of chapter 5 in the dev manual, i'm going to do this in bite-size pieces. (From yocto-docs rev: 3db48a0be170a02e5042fe65253c65b5245c6b89) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 26 +++++++++++-------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index bd8c2c9be9..e2df99e491 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -10,7 +10,7 @@ adding new software packages, extending or customizing images, porting work to new hardware (adding a new machine), and so forth. You will find the procedures documented here occur often in the - develop cycle using the Yocto Project. + development cycle using the Yocto Project.
@@ -31,7 +31,7 @@ To illustrate how layers are used to keep things modular, consider machine customizations. These types of customizations typically reside in a special layer, - rather than a general layer, called a Board Specific Package (BSP) + rather than a general layer, called a Board Support Package (BSP) Layer. Furthermore, the machine customizations should be isolated from recipes and Metadata that support a new GUI environment, @@ -60,11 +60,12 @@ You can easily identify layers that ship with a Yocto Project release in the Source Directory by their folder names. - Folders that are layers begin with the string - meta. + Folders that represent layers typically have names that begin with + the string meta-. - It is not a requirement that a layer begins with the - string meta. + It is not a requirement that a layer name begin with the + prefix meta-, but it's a commonly accepted + standard in the Yocto Project community. For example, when you set up the Source Directory structure, you will see several layers: @@ -72,14 +73,14 @@ meta-skeleton, meta-yocto, and meta-yocto-bsp. - Each of these folders is a layer. + Each of these folders represents a distinct layer. Furthermore, if you set up a local copy of the meta-intel Git repository and then explore the folder of that general layer, - you will discover many BSP layers inside. + you will discover many Intel-specific BSP layers inside. For more information on BSP layers, see the "BSP Layers" section in the Yocto Project Board Support Package (BSP) @@ -252,8 +253,8 @@ configuration. In other words, do not copy an entire recipe into your layer and then modify it. - Use .bbappend files to override the - parts of the recipe you need to modify. + Rather, use .bbappend files to override the + only those parts of the original recipe you need to modify.
@@ -275,6 +276,9 @@ the layer to which it originally belongs. If this is the case, you need to address that deficiency instead of overlaying the include file. + + + For example, consider how support plug-ins for the Qt 4 database are configured. The Source Directory does not have MySQL or PostgreSQL. @@ -496,7 +500,7 @@ number-specific. If the corresponding recipe is renamed to update to a newer version, the corresponding .bbappend file must - be renamed as well. + be renamed (and possibly updated) as well. During the build process, BitBake displays an error on starting if it detects a .bbappend file that does not have a corresponding recipe with a matching name.