summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-02-12 09:11:37 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-02-14 15:25:32 +0000
commitcfdf4c78eb442169c32cb4d67fe7afe203de0d50 (patch)
tree78145d63fdff6d8807b87ad42ce0b8bdfdf78b96 /documentation/dev-manual
parent4b3ebf00dc8eac6061ff077cff488f70c641d16e (diff)
downloadpoky-cfdf4c78eb442169c32cb4d67fe7afe203de0d50.tar.gz
getting-started, dev-manual: Created Layer Model section
This involved removing the general information about layers from the dev-manual and incorporating it into the new section of the getting-started manual. (From yocto-docs rev: 26438b03751948661f48fb0c023e393101b80e19) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml74
1 files changed, 4 insertions, 70 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 8e8b06fba1..f757465935 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -22,78 +22,12 @@
22 multiple layers. 22 multiple layers.
23 Layers allow you to isolate different types of customizations from 23 Layers allow you to isolate different types of customizations from
24 each other. 24 each other.
25 You might find it tempting to keep everything in one layer when 25 For introductory information on the Yocto Project Layer Model,
26 working on a single project. 26 see the
27 However, the more modular your Metadata, the easier 27 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
28 it is to cope with future changes. 28 section in the Getting Started With Yocto Project Manual.
29 </para>
30
31 <para>
32 To illustrate how layers are used to keep things modular, consider
33 machine customizations.
34 These types of customizations typically reside in a special layer,
35 rather than a general layer, called a Board Support Package (BSP)
36 Layer.
37 Furthermore, the machine customizations should be isolated from
38 recipes and Metadata that support a new GUI environment,
39 for example.
40 This situation gives you a couple of layers: one for the machine
41 configurations, and one for the GUI environment.
42 It is important to understand, however, that the BSP layer can
43 still make machine-specific additions to recipes within the GUI
44 environment layer without polluting the GUI layer itself
45 with those machine-specific changes.
46 You can accomplish this through a recipe that is a BitBake append
47 (<filename>.bbappend</filename>) file, which is described later
48 in this section.
49 <note>
50 For general information on BSP layer structure, see the
51 <ulink url='&YOCTO_DOCS_BSP_URL;#bsp'>Board Support Packages (BSP) - Developer's Guide</ulink>.
52 </note>
53 </para>
54
55 <para>
56 </para> 29 </para>
57 30
58 <section id='yocto-project-layers'>
59 <title>Layers</title>
60
61 <para>
62 The <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>
63 contains both general layers and BSP
64 layers right out of the box.
65 You can easily identify layers that ship with a
66 Yocto Project release in the Source Directory by their
67 folder names.
68 Folders that represent layers typically have names that begin with
69 the string <filename>meta-</filename>.
70 <note>
71 It is not a requirement that a layer name begin with the
72 prefix <filename>meta-</filename>, but it is a commonly
73 accepted standard in the Yocto Project community.
74 </note>
75 For example, when you set up the Source Directory structure,
76 you will see several layers:
77 <filename>meta</filename>,
78 <filename>meta-skeleton</filename>,
79 <filename>meta-selftest</filename>,
80 <filename>meta-poky</filename>, and
81 <filename>meta-yocto-bsp</filename>.
82 Each of these folders represents a distinct layer.
83 </para>
84
85 <para>
86 As another example, if you set up a local copy of the
87 <filename>meta-intel</filename> Git repository
88 and then explore the folder of that general layer,
89 you will discover many Intel-specific BSP layers inside.
90 For more information on BSP layers, see the
91 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>"
92 section in the Yocto Project Board Support Package (BSP)
93 Developer's Guide.
94 </para>
95 </section>
96
97 <section id='creating-your-own-layer'> 31 <section id='creating-your-own-layer'>
98 <title>Creating Your Own Layer</title> 32 <title>Creating Your Own Layer</title>
99 33