summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-04-04 15:16:38 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-04-10 13:32:45 +0100
commitec33e21004c773df60ad0dc5e0a2d04ff9414d62 (patch)
tree3701f1644ca32a1a82788c858ef97b77eb348771 /documentation
parent273e05bb0db2d3723429e47523deee1c8b302471 (diff)
downloadpoky-ec33e21004c773df60ad0dc5e0a2d04ff9414d62.tar.gz
documentation/bsp-guide/bsp.xml: Edits to intro sections
Adding the new section "Customizing a Recipe for a BSP" has added enough sections to this book such that the introductory area needed some attention. I pared down the intro text to basically just cover the manual's organization and a bit about BSPs. I moved all the introductory common form stuff into the section that just addresses the BSP form. This is better organization for the manual as it is evolving. (From yocto-docs rev: 9aec4ce47fb090ae2f6c5bed93da03e77ae49a4c) 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.xml68
1 files changed, 34 insertions, 34 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index d15abe027d..f12db850fc 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -19,44 +19,15 @@
19 </para> 19 </para>
20 20
21 <para> 21 <para>
22 This chapter (or document if you are reading the BSP Developer's Guide) defines 22 This chapter (or document if you are reading the BSP Developer's Guide)
23 a structure for these components 23 talks about BSP Layers, defines a structure for components
24 so that BSPs follow a commonly understood layout. 24 so that BSPs follow a commonly understood layout, discusses how to customize
25 The information here also shows how you can create and manage a 25 a recipe for a BSP, addresses BSP licensing, and provides information that
26 shows you how to create and manage a
26 <link linkend='bsp-layers'>BSP Layer</link> using two Yocto Project 27 <link linkend='bsp-layers'>BSP Layer</link> using two Yocto Project
27 <link linkend='using-the-yocto-projects-bsp-tools'>BSP Tools</link>. 28 <link linkend='using-the-yocto-projects-bsp-tools'>BSP Tools</link>.
28 </para> 29 </para>
29 30
30 <para>
31 Providing a common form allows end-users to understand and become familiar
32 with the layout.
33 A common form also encourages standardization
34 of software support of hardware.
35 </para>
36
37 <para>
38 The proposed format does have elements that are specific to the Yocto Project and
39 OpenEmbedded build systems.
40 It is intended that this information can be
41 used by other systems besides Yocto Project and OpenEmbedded and that it will be simple
42 to extract information and convert it to other formats if required.
43 Yocto Project, through its standard layers mechanism, can directly accept the format
44 described as a layer.
45 The BSP captures all
46 the hardware-specific details in one place in a standard format, which is
47 useful for any person wishing to use the hardware platform regardless of
48 the build system they are using.
49 </para>
50
51 <para>
52 The BSP specification does not include a build system or other tools -
53 it is concerned with the hardware-specific components only.
54 At the end-distribution point, you can ship the BSP combined with a build system
55 and other tools.
56 However, it is important to maintain the distinction that these
57 are separate components that happen to be combined in certain end products.
58 </para>
59
60 <section id='bsp-layers'> 31 <section id='bsp-layers'>
61 <title>BSP Layers</title> 32 <title>BSP Layers</title>
62 33
@@ -116,6 +87,35 @@
116 <title>Example Filesystem Layout</title> 87 <title>Example Filesystem Layout</title>
117 88
118 <para> 89 <para>
90 Providing a common form allows end-users to understand and become familiar
91 with the layout.
92 A common format also encourages standardization of software support of hardware.
93 </para>
94
95 <para>
96 The proposed form does have elements that are specific to the Yocto Project and
97 OpenEmbedded build systems.
98 It is intended that this information can be
99 used by other systems besides Yocto Project and OpenEmbedded and that it will be simple
100 to extract information and convert it to other formats if required.
101 Yocto Project, through its standard layers mechanism, can directly accept the format
102 described as a layer.
103 The BSP captures all
104 the hardware-specific details in one place in a standard format, which is
105 useful for any person wishing to use the hardware platform regardless of
106 the build system they are using.
107 </para>
108
109 <para>
110 The BSP specification does not include a build system or other tools -
111 it is concerned with the hardware-specific components only.
112 At the end-distribution point, you can ship the BSP combined with a build system
113 and other tools.
114 However, it is important to maintain the distinction that these
115 are separate components that happen to be combined in certain end products.
116 </para>
117
118 <para>
119 Below is the common form for the file structure inside a BSP Layer. 119 Below is the common form for the file structure inside a BSP Layer.
120 While you can use this basic form for the standard, realize that the actual structures 120 While you can use this basic form for the standard, realize that the actual structures
121 for specific BSPs could differ. 121 for specific BSPs could differ.