summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-02-17 15:03:46 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 12:07:57 -0800
commit4dd2dc988629022cbc345fafe3afc329a0fbc1fc (patch)
treebef7ec7b86b5263e51931ef3e02e95122901712a /documentation
parentf7fb723548f7c89173cb92e36262ecf4e2264ebb (diff)
downloadpoky-4dd2dc988629022cbc345fafe3afc329a0fbc1fc.tar.gz
documentation/bsp-guide/bsp.xml: Edits for BSP Layer understanding
I added a small section at the start of chapter to define a BSP Layer, note where the YP keeps them, and note that meta-intel is somewhat of a "super" layer as it contains several BSP layers of its own. (From yocto-docs rev: 2e044072660d3f675612e01e3871d6a4fb0894bd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/bsp-guide/bsp.xml54
1 files changed, 41 insertions, 13 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 4deab843bc..1ada40e705 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -61,32 +61,52 @@
61 are separate components that happen to be combined in certain end products. 61 are separate components that happen to be combined in certain end products.
62 </para> 62 </para>
63 63
64 <section id="bsp-filelayout"> 64 <section id='bsp-layers'>
65 <title>Example Filesystem Layout</title> 65 <title>BSP Layers</title>
66 66
67 <para> 67 <para>
68 The BSP consists of a file structure inside a base directory, which uses the following 68 The BSP consists of a file structure inside a base directory.
69 naming convention: 69 Collectively, you can think of the base directory and the file structure
70 as a BSP Layer.
71 BSP Layers use the following naming convention:
70 <literallayout class='monospaced'> 72 <literallayout class='monospaced'>
71 meta-&lt;bsp_name&gt; 73 meta-&lt;bsp_name&gt;
72 </literallayout> 74 </literallayout>
75 "bsp_name" is a placeholder for the machine or platform name.
73 </para> 76 </para>
74 77
75 <para> 78 <para>
76 "bsp_name" is a placeholder for the machine or platform name. 79 The Yocto Project organizes BSP Layers within the Yocto Metadata Layers area
77 Here are some example base directory names: 80 of the Yocto Project Source Repositories at
81 <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>.
82 If you examine the source repositories, you will find many BSP Layers.
83 Here are a few:
78 <literallayout class='monospaced'> 84 <literallayout class='monospaced'>
85 meta-baryon
86 meta-fsl-ppc
87 meta-intel
88 meta-selinux
89 meta-ti
90 </literallayout>
91 It is worth noting that the <filename>meta-intel</filename> BSP Layer contains
92 within itself several other BSP Layers, which makes it sort of a "super" layer.
93 Following is a sampling of the BSP Layers that the <filename>meta-intel</filename>
94 BSP Layer contains:
95 <literallayout class='monospaced'>
96 meta-cedartrail
97 meta-crownbay
79 meta-emenlow 98 meta-emenlow
80 meta-n450 99 meta-fishriver
81 meta-beagleboard 100 meta-fri2
82 </literallayout> 101 </literallayout>
83 </para> 102 </para>
84 103
85 <para> 104 <para>
86 The base directory (<filename>meta-&lt;bsp_name&gt;</filename>) is the root of the BSP layer. 105 The layer's base directory (<filename>meta-&lt;bsp_name&gt;</filename>) is the root
106 of the BSP Layer.
87 This root is what you add to the <filename>BBLAYERS</filename> 107 This root is what you add to the <filename>BBLAYERS</filename>
88 variable in the <filename>build/conf/bblayers.conf</filename> file found in the 108 variable in the <filename>build/conf/bblayers.conf</filename> file found in the
89 Yocto Project file's build directory. 109 <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-build-directory'>Yocto Project Build Directory</ulink>.
90 Adding the root allows the Yocto Project build system to recognize the BSP 110 Adding the root allows the Yocto Project build system to recognize the BSP
91 definition and from it build an image. 111 definition and from it build an image.
92 Here is an example: 112 Here is an example:
@@ -97,16 +117,24 @@
97 /usr/local/src/yocto/meta-&lt;bsp_name&gt; \ 117 /usr/local/src/yocto/meta-&lt;bsp_name&gt; \
98 " 118 "
99 </literallayout> 119 </literallayout>
120 </para>
121
122 <para>
100 For more detailed information on layers, see the 123 For more detailed information on layers, see the
101 "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#usingpoky-changes-layers'>BitBake Layers</ulink>" 124 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#usingpoky-changes-layers'>Bitbake Layers</ulink>"
102 section of the Yocto Project Reference Manual. 125 section of the Yocto Project Development Manual.
103 You can also see the detailed examples in the appendices of 126 You can also see the detailed examples in the appendices of
104 <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'> 127 <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>
105 The Yocto Project Development Manual</ulink>. 128 The Yocto Project Development Manual</ulink>.
106 </para> 129 </para>
130 </section>
131
132
133 <section id="bsp-filelayout">
134 <title>Example Filesystem Layout</title>
107 135
108 <para> 136 <para>
109 Below is the common form for the file structure inside a base directory. 137 Below is the common form for the file structure inside a BSP Layer.
110 While you can use this basic form for the standard, realize that the actual structures 138 While you can use this basic form for the standard, realize that the actual structures
111 for specific BSPs could differ. 139 for specific BSPs could differ.
112 140