diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-03-07 16:05:02 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-03-25 09:41:11 +0100 |
commit | 4c4076add1a6ce5d1bd39f61f64971332a4b4139 (patch) | |
tree | d872404256b08808944312ceb7a9bb9339f53f50 /documentation/bsp-guide/bsp.xml | |
parent | 54737f81cc3efad60acf46e146c847d9cf8e0709 (diff) | |
download | poky-4c4076add1a6ce5d1bd39f61f64971332a4b4139.tar.gz |
bsp-guide: General edits to "BSP Layers" section
Added more relevant information around the discussion of BSP
layers.
(From yocto-docs rev: 8ca439b0bbfdcf390edb723fd12e8a00d90024e3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/bsp-guide/bsp.xml')
-rw-r--r-- | documentation/bsp-guide/bsp.xml | 47 |
1 files changed, 29 insertions, 18 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 5c6f9df7ab..e026cefd8c 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml | |||
@@ -34,8 +34,8 @@ | |||
34 | A BSP consists of a file structure inside a base directory. | 34 | A BSP consists of a file structure inside a base directory. |
35 | Collectively, you can think of the base directory, its file structure, | 35 | Collectively, you can think of the base directory, its file structure, |
36 | and the contents as a BSP Layer. | 36 | and the contents as a BSP Layer. |
37 | Although not a strict requirement, layers in the Yocto Project use the | 37 | Although not a strict requirement, BSP layers in the Yocto Project |
38 | following well-established naming convention: | 38 | use the following well-established naming convention: |
39 | <literallayout class='monospaced'> | 39 | <literallayout class='monospaced'> |
40 | meta-<replaceable>bsp_name</replaceable> | 40 | meta-<replaceable>bsp_name</replaceable> |
41 | </literallayout> | 41 | </literallayout> |
@@ -46,8 +46,8 @@ | |||
46 | it is advisable to follow it when creating layers. | 46 | it is advisable to follow it when creating layers. |
47 | Technically speaking, a BSP layer name does not need to | 47 | Technically speaking, a BSP layer name does not need to |
48 | start with <filename>meta-</filename>. | 48 | start with <filename>meta-</filename>. |
49 | However, you might run into situations where obscure | 49 | However, various scripts and tools in the Yocto Project |
50 | scripts assume this convention. | 50 | development environment assume this convention. |
51 | </note> | 51 | </note> |
52 | </para> | 52 | </para> |
53 | 53 | ||
@@ -58,9 +58,15 @@ | |||
58 | <ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink> | 58 | <ulink url='&YOCTO_DOCS_GS_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink> |
59 | through a web interface at | 59 | through a web interface at |
60 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>. | 60 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>. |
61 | If you go to that interface, you will find near the bottom of the list | 61 | If you go to that interface, you will find a list of repositories |
62 | under "Yocto Metadata Layers" several BSP layers all of which are | 62 | under "Yocto Metadata Layers". |
63 | supported by the Yocto Project (e.g. <filename>meta-raspberrypi</filename> and | 63 | <note> |
64 | Layers that are no longer actively supported as part of the | ||
65 | Yocto Project appear under the heading "Yocto Metadata Layer | ||
66 | Archive." | ||
67 | </note> | ||
68 | Each repository is a BSP layer supported by the Yocto Project | ||
69 | (e.g. <filename>meta-raspberrypi</filename> and | ||
64 | <filename>meta-intel</filename>). | 70 | <filename>meta-intel</filename>). |
65 | Each of these layers is a repository unto itself and clicking on a | 71 | Each of these layers is a repository unto itself and clicking on a |
66 | layer reveals information that includes two links from which you can choose | 72 | layer reveals information that includes two links from which you can choose |
@@ -72,13 +78,12 @@ | |||
72 | </para> | 78 | </para> |
73 | 79 | ||
74 | <para> | 80 | <para> |
75 | In addition to BSP layers near the bottom of that referenced | 81 | In addition to BSP layers, the |
76 | Yocto Project Source Repository, the | ||
77 | <filename>meta-yocto-bsp</filename> layer is part of the | 82 | <filename>meta-yocto-bsp</filename> layer is part of the |
78 | shipped <filename>poky</filename> repository. | 83 | shipped <filename>poky</filename> repository. |
79 | The <filename>meta-yocto-bsp</filename> layer maintains several | 84 | The <filename>meta-yocto-bsp</filename> layer maintains several |
80 | BSPs such as the Beaglebone, EdgeRouter, and generic versions of | 85 | BSPs such as the Beaglebone, EdgeRouter, and generic versions of |
81 | both 32 and 64-bit IA machines. | 86 | both 32-bit and 64-bit IA machines. |
82 | </para> | 87 | </para> |
83 | 88 | ||
84 | <para> | 89 | <para> |
@@ -102,8 +107,9 @@ | |||
102 | which is established after you run the OpenEmbedded build environment | 107 | which is established after you run the OpenEmbedded build environment |
103 | setup script (i.e. | 108 | setup script (i.e. |
104 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>). | 109 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>). |
105 | Adding the root allows the OpenEmbedded build system to recognize the BSP | 110 | Adding the root allows the |
106 | definition and from it build an image. | 111 | <ulink url='&YOCTO_DOCS_REF_URL;#build-system-term'>OpenEmbedded build system</ulink> |
112 | to recognize the BSP layer and from it build an image. | ||
107 | Here is an example: | 113 | Here is an example: |
108 | <literallayout class='monospaced'> | 114 | <literallayout class='monospaced'> |
109 | BBLAYERS ?= " \ | 115 | BBLAYERS ?= " \ |
@@ -129,15 +135,20 @@ | |||
129 | 135 | ||
130 | <para> | 136 | <para> |
131 | Some layers function as a layer to hold other BSP layers. | 137 | Some layers function as a layer to hold other BSP layers. |
132 | An example of this type of layer is the <filename>meta-intel</filename> layer, | 138 | An example of this type of layer is the |
133 | which contains a number of individual BSP sub-layers, as well as a directory | 139 | <filename>meta-intel</filename> layer. |
134 | named <filename>common/</filename> full of common content across those layers. | 140 | This layer contains BSP layers for the Intel-core2-32 |
135 | Another example is the <filename>meta-yocto-bsp</filename> layer mentioned | 141 | <trademark class='registered'>Intel</trademark> Common Core |
136 | earlier. | 142 | (Intel-core2-32) and the Intel-corei7-64 |
143 | <trademark class='registered'>Intel</trademark> Common Core | ||
144 | (Intel-corei7-64). | ||
145 | the <filename>meta-intel</filename> layer also contains | ||
146 | the <filename>common/</filename> directory, which contains | ||
147 | common content across those layers. | ||
137 | </para> | 148 | </para> |
138 | 149 | ||
139 | <para> | 150 | <para> |
140 | For more detailed information on layers, see the | 151 | For more information on layers, see the |
141 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" | 152 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" |
142 | section of the Yocto Project Development Tasks Manual. | 153 | section of the Yocto Project Development Tasks Manual. |
143 | </para> | 154 | </para> |