diff options
author | Robert P. J. Day <rpjday@crashcourse.ca> | 2013-11-11 11:02:57 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-03 12:53:08 +0000 |
commit | 2e44a480478c5679e8b6240062f7c94019befc6b (patch) | |
tree | a2b40c43cfbdf049505a44e8154c83db08b5213e | |
parent | c65a2f1f5b6725104e4c21b2442e9978d413c1c2 (diff) | |
download | poky-2e44a480478c5679e8b6240062f7c94019befc6b.tar.gz |
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: ccfe3e719bf71236e50b3e4507a6d63199f24ff5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 26 |
1 files 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 7d5063b79b..0ee7775ca8 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -10,7 +10,7 @@ | |||
10 | adding new software packages, extending or customizing images, | 10 | adding new software packages, extending or customizing images, |
11 | porting work to new hardware (adding a new machine), and so forth. | 11 | porting work to new hardware (adding a new machine), and so forth. |
12 | You will find the procedures documented here occur often in the | 12 | You will find the procedures documented here occur often in the |
13 | develop cycle using the Yocto Project. | 13 | development cycle using the Yocto Project. |
14 | </para> | 14 | </para> |
15 | 15 | ||
16 | <section id="understanding-and-creating-layers"> | 16 | <section id="understanding-and-creating-layers"> |
@@ -31,7 +31,7 @@ | |||
31 | To illustrate how layers are used to keep things modular, consider | 31 | To illustrate how layers are used to keep things modular, consider |
32 | machine customizations. | 32 | machine customizations. |
33 | These types of customizations typically reside in a special layer, | 33 | These types of customizations typically reside in a special layer, |
34 | rather than a general layer, called a Board Specific Package (BSP) | 34 | rather than a general layer, called a Board Support Package (BSP) |
35 | Layer. | 35 | Layer. |
36 | Furthermore, the machine customizations should be isolated from | 36 | Furthermore, the machine customizations should be isolated from |
37 | recipes and Metadata that support a new GUI environment, | 37 | recipes and Metadata that support a new GUI environment, |
@@ -60,11 +60,12 @@ | |||
60 | You can easily identify layers that ship with a | 60 | You can easily identify layers that ship with a |
61 | Yocto Project release in the Source Directory by their | 61 | Yocto Project release in the Source Directory by their |
62 | folder names. | 62 | folder names. |
63 | Folders that are layers begin with the string | 63 | Folders that represent layers typically have names that begin with |
64 | <filename>meta</filename>. | 64 | the string <filename>meta-</filename>. |
65 | <note> | 65 | <note> |
66 | It is not a requirement that a layer begins with the | 66 | It is not a requirement that a layer name begin with the |
67 | string <filename>meta</filename>. | 67 | prefix <filename>meta-</filename>, but it's a commonly accepted |
68 | standard in the Yocto Project community. | ||
68 | </note> | 69 | </note> |
69 | For example, when you set up the Source Directory structure, | 70 | For example, when you set up the Source Directory structure, |
70 | you will see several layers: | 71 | you will see several layers: |
@@ -72,14 +73,14 @@ | |||
72 | <filename>meta-skeleton</filename>, | 73 | <filename>meta-skeleton</filename>, |
73 | <filename>meta-yocto</filename>, and | 74 | <filename>meta-yocto</filename>, and |
74 | <filename>meta-yocto-bsp</filename>. | 75 | <filename>meta-yocto-bsp</filename>. |
75 | Each of these folders is a layer. | 76 | Each of these folders represents a distinct layer. |
76 | </para> | 77 | </para> |
77 | 78 | ||
78 | <para> | 79 | <para> |
79 | Furthermore, if you set up a local copy of the | 80 | Furthermore, if you set up a local copy of the |
80 | <filename>meta-intel</filename> Git repository | 81 | <filename>meta-intel</filename> Git repository |
81 | and then explore the folder of that general layer, | 82 | and then explore the folder of that general layer, |
82 | you will discover many BSP layers inside. | 83 | you will discover many Intel-specific BSP layers inside. |
83 | For more information on BSP layers, see the | 84 | For more information on BSP layers, see the |
84 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" | 85 | "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" |
85 | section in the Yocto Project Board Support Package (BSP) | 86 | section in the Yocto Project Board Support Package (BSP) |
@@ -252,8 +253,8 @@ | |||
252 | configuration. | 253 | configuration. |
253 | In other words, do not copy an entire recipe into your | 254 | In other words, do not copy an entire recipe into your |
254 | layer and then modify it. | 255 | layer and then modify it. |
255 | Use <filename>.bbappend</filename> files to override the | 256 | Rather, use <filename>.bbappend</filename> files to override the |
256 | parts of the recipe you need to modify. | 257 | only those parts of the original recipe you need to modify. |
257 | </para> | 258 | </para> |
258 | </section> | 259 | </section> |
259 | 260 | ||
@@ -275,6 +276,9 @@ | |||
275 | the layer to which it originally belongs. | 276 | the layer to which it originally belongs. |
276 | If this is the case, you need to address that deficiency | 277 | If this is the case, you need to address that deficiency |
277 | instead of overlaying the include file. | 278 | instead of overlaying the include file. |
279 | </para> | ||
280 | |||
281 | <para> | ||
278 | For example, consider how support plug-ins for the Qt 4 | 282 | For example, consider how support plug-ins for the Qt 4 |
279 | database are configured. | 283 | database are configured. |
280 | The Source Directory does not have MySQL or PostgreSQL. | 284 | The Source Directory does not have MySQL or PostgreSQL. |
@@ -496,7 +500,7 @@ | |||
496 | number-specific. | 500 | number-specific. |
497 | If the corresponding recipe is renamed to update to a newer | 501 | If the corresponding recipe is renamed to update to a newer |
498 | version, the corresponding <filename>.bbappend</filename> file must | 502 | version, the corresponding <filename>.bbappend</filename> file must |
499 | be renamed as well. | 503 | be renamed (and possibly updated) as well. |
500 | During the build process, BitBake displays an error on starting | 504 | During the build process, BitBake displays an error on starting |
501 | if it detects a <filename>.bbappend</filename> file that does | 505 | if it detects a <filename>.bbappend</filename> file that does |
502 | not have a corresponding recipe with a matching name. | 506 | not have a corresponding recipe with a matching name. |