summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-05 09:49:20 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-06-18 10:30:44 +0100
commit926a8ee45b291da32aa9cc32050f2fb800a08c8f (patch)
tree4048bad19dc28fb2a5bb4399ca65a87a1eabb830 /documentation
parent10996ccceb24118fd3edbfeb459663d5d37f92df (diff)
downloadpoky-926a8ee45b291da32aa9cc32050f2fb800a08c8f.tar.gz
bsp-guide: Edits to "BSP Layers" section adding locator info.
I extended the section to mention where to find YP supported BSP layers and a bit on how to get them via the link from the Source Repositories web interface. Changes driven by community input. (From yocto-docs rev: 4c944bf33b7d642126c52efd313666270145ab50) 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.xml41
1 files changed, 37 insertions, 4 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index eef36cbc3f..2d036fc5ac 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -31,9 +31,9 @@
31 <title>BSP Layers</title> 31 <title>BSP Layers</title>
32 32
33 <para> 33 <para>
34 The 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 and the file structure 35 Collectively, you can think of the base directory, its file structure,
36 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, layers in the Yocto Project use the
38 following well established naming convention: 38 following well established naming convention:
39 <literallayout class='monospaced'> 39 <literallayout class='monospaced'>
@@ -44,12 +44,45 @@
44 </para> 44 </para>
45 45
46 <para> 46 <para>
47 To help understand the BSP layer concept, consider the BSPs that the
48 Yocto Project supports and provides with each release.
49 You can see the layers in the
50 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>
51 through a web interface at
52 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>.
53 If you go to that interface you will find near the bottom of the list
54 under "Yocto Metadata Layers" several BSP layers all of which are
55 supported by the Yocto Project (e.g. <filename>meta-minnow</filename>,
56 <filename>meta-raspberrypi</filename>, and
57 <filename>meta-intel</filename>).
58 Each of these layers is a repository unto itself and clicking on a
59 layer reveals information that includes two links from which you can choose
60 to set up a clone of the layer's repository on your local host system.
61 Here is an example that clones the Minnow Board BSP layer:
62 <literallayout class='monospaced'>
63 $ git clone git://git.yoctoproject.org/meta-minnow
64 </literallayout>
65 For information on the BSP development workflow, see the
66 "<ulink url='&YOCTO_DOCS_DEV_URL;#developing-a-board-support-package-bsp'>Developing a Board Support Package (BSP)</ulink>"
67 section in the Yocto Project Development Manual.
68 For more information on how to set up a local copy of source files
69 from a Git repository, see the
70 "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>"
71 section also in the Yocto Project Development Manual.
72 </para>
73
74 <para>
47 The layer's base directory (<filename>meta-&lt;bsp_name&gt;</filename>) is the root 75 The layer's base directory (<filename>meta-&lt;bsp_name&gt;</filename>) is the root
48 of the BSP Layer. 76 of the BSP Layer.
49 This root is what you add to the 77 This root is what you add to the
50 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> 78 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink>
51 variable in the <filename>conf/bblayers.conf</filename> file found in the 79 variable in the <filename>conf/bblayers.conf</filename> file found in the
52 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 80 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
81 which is establishe after you run one of the OpenEmbedded build environment
82 setup scripts (i.e.
83 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
84 and
85 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>).
53 Adding the root allows the OpenEmbedded build system to recognize the BSP 86 Adding the root allows the OpenEmbedded build system to recognize the BSP
54 definition and from it build an image. 87 definition and from it build an image.
55 Here is an example: 88 Here is an example: