summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-model.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-07-27 12:47:59 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-08-04 15:06:47 +0100
commit4737719dc196f98aef768fd814c96adfe1069759 (patch)
tree4d90f5476746ed32790b44b224a1ac8da761fb0a /documentation/dev-manual/dev-manual-model.xml
parent3aef350c390a270a410673435de63ee5d21d117b (diff)
downloadpoky-4737719dc196f98aef768fd814c96adfe1069759.tar.gz
documentation/dev-manual/dev-manual-model.xml: Added structure
I added structure to contain sub-sections for system (BSP and kernel) and application overviews. (From yocto-docs rev: 028f65219b001081d221d63f368ff06066a95a64) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-model.xml')
-rw-r--r--documentation/dev-manual/dev-manual-model.xml73
1 files changed, 56 insertions, 17 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 8d8c2ae33e..7dede8aa28 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -19,11 +19,42 @@
19 (system development and application development)]. 19 (system development and application development)].
20</para> 20</para>
21 21
22<section id='place-holder-section-one'> 22<para>
23 <title>Place-Holder Section for Development in General</title> 23 Many development models exist for which you can use the Yocto Project.
24 However, for the purposes of this manual we are going to focus on two common ones:
25 System Development and User Application Development.
26 System Development covers Board Support Package (BSP) development and kernel modification.
27 User Application Development covers development of applications that you intend to run on some
28 target hardware.
29</para>
30
31<para>
32 This chapter presents an overview of the primary models.
33 Supsequent appendices in the manual provide detailed explanations of the examples.
34</para>
35
36<para>
37 [WRITERS NOTE: What is undetermined at this point is how much of the entire development process
38 we include in this particular chapter.
39 In other words, do we cover debugging and emulation steps here on a case-specific basis?
40 Or, do we capture that information in the appropriate subsequent chapter by case?]
41</para>
42
43<section id='system-development-model'>
44 <title>System Development</title>
24 45
25 <para> 46 <para>
26 Text needed here. 47 System development involves modification or creation of an image that you want to run on
48 a specific hardware target.
49 Usually when you want to create an image that runs on embedded hardware the image does
50 not require the same amount of features that a full-fledged Linux distribution provides.
51 Thus, you can create a much smaller image that is designed to just use the hardware
52 features for your particular hardware.
53 </para>
54
55 <para>
56 To help you understand how system development works in the Yocto Project, this section
57 covers two types of image development: BSP creation and kernel modification.
27 </para> 58 </para>
28 59
29 <section id='developing-a-board-support-package-bsp-model'> 60 <section id='developing-a-board-support-package-bsp-model'>
@@ -70,7 +101,7 @@
70 recipes and configuration files from scratch. 101 recipes and configuration files from scratch.
71 While it is possible to create everything from scratch, basing your new BSP 102 While it is possible to create everything from scratch, basing your new BSP
72 on something that is close is much easier. 103 on something that is close is much easier.
73 Or, at a minimum, it gives you some structure with which to start.</para> 104 Or, at a minimum, it gives you some structure with which to start.</para>
74 <para>At this point you need to understand your target hardware well enough to determine which 105 <para>At this point you need to understand your target hardware well enough to determine which
75 existing BSP it most closely matches. 106 existing BSP it most closely matches.
76 Things to consider are your hardware’s on-board features such as CPU type and graphics support. 107 Things to consider are your hardware’s on-board features such as CPU type and graphics support.
@@ -82,13 +113,13 @@
82 <para>To see the supported BSPs, go to the Yocto Project 113 <para>To see the supported BSPs, go to the Yocto Project
83 <ulink url='http://www.yoctoproject.org/download'>download page</ulink> and click 114 <ulink url='http://www.yoctoproject.org/download'>download page</ulink> and click
84 on “BSP Downloads.”</para></listitem> 115 on “BSP Downloads.”</para></listitem>
85 <listitem><para><emphasis>Establish a local copy of the base BSP files</emphasis>: Having 116 <listitem><para><emphasis>Establish a local copy of the base BSP files</emphasis>: Having
86 the BSP files on your system gives you access to the build 117 the BSP files on your system gives you access to the build
87 process and tools you need. 118 process and tools you need.
88 For information on how to get these files, see 119 For information on how to get these files, see
89 <xref linkend='getting-setup'>Getting Setup</xref> earlier in this manual.</para></listitem> 120 <xref linkend='getting-setup'>Getting Setup</xref> earlier in this manual.</para></listitem>
90 <listitem><para><emphasis>Create your own BSP layer</emphasis>: Layers are ideal for 121 <listitem><para><emphasis>Create your own BSP layer</emphasis>: Layers are ideal for
91 isolating and storing work for a given piece of hardware. 122 isolating and storing work for a given piece of hardware.
92 A layer is really just a location or area in which you place the recipes for your BSP. 123 A layer is really just a location or area in which you place the recipes for your BSP.
93 In fact, a BSP is, in itself, a special type of layer. 124 In fact, a BSP is, in itself, a special type of layer.
94 Consider an application as another example that illustrates a layer. 125 Consider an application as another example that illustrates a layer.
@@ -99,8 +130,8 @@
99 all the relevant information for the project that the Yocto Project build 130 all the relevant information for the project that the Yocto Project build
100 system knows about.</para> 131 system knows about.</para>
101 <note>The Yocto Project supports four BSPs that are part of the 132 <note>The Yocto Project supports four BSPs that are part of the
102 Yocto Project release: <filename>atom-pc</filename>, <filename>beagleboard</filename>, 133 Yocto Project release: <filename>atom-pc</filename>, <filename>beagleboard</filename>,
103 <filename>mpc8315e</filename>, and <filename>routerstationpro</filename>. 134 <filename>mpc8315e</filename>, and <filename>routerstationpro</filename>.
104 The recipes and configurations for these four BSPs are located and dispersed 135 The recipes and configurations for these four BSPs are located and dispersed
105 within local Yocto Project files. 136 within local Yocto Project files.
106 Consequently, they are not totally isolated in the spirit of layers unless you think 137 Consequently, they are not totally isolated in the spirit of layers unless you think
@@ -109,7 +140,7 @@
109 N450, and Sugar Bay are isolated.</note> 140 N450, and Sugar Bay are isolated.</note>
110 <para>When you set up a layer for a new BSP you should follow a standard layout. 141 <para>When you set up a layer for a new BSP you should follow a standard layout.
111 This layout is described in the 142 This layout is described in the
112 <ulink url='http://www.yoctoproject.org/docs/1.1/bsp-guide/bsp-guide.html#bsp-filelayout'> 143 <ulink url='http://www.yoctoproject.org/docs/1.1/bsp-guide/bsp-guide.html#bsp-filelayout'>
113 Example Filesystem Layout</ulink> section of the Board Support Package (BSP) Development 144 Example Filesystem Layout</ulink> section of the Board Support Package (BSP) Development
114 Guide. 145 Guide.
115 In the standard layout you will notice a suggested structure for recipes and 146 In the standard layout you will notice a suggested structure for recipes and
@@ -120,7 +151,7 @@
120 <listitem><para><emphasis>Make configuration and recipe changes to your new BSP 151 <listitem><para><emphasis>Make configuration and recipe changes to your new BSP
121 layer</emphasis>: The standard BSP layer structure organizes the files you need to edit in 152 layer</emphasis>: The standard BSP layer structure organizes the files you need to edit in
122 <filename>conf</filename> and several <filename>recipes-*</filename> within the 153 <filename>conf</filename> and several <filename>recipes-*</filename> within the
123 BSP layer.</para> 154 BSP layer.</para>
124 <para>Configuration changes identify where your new layer is on the local system 155 <para>Configuration changes identify where your new layer is on the local system
125 and identify which kernel you are going to use. 156 and identify which kernel you are going to use.
126 Recipe changes include altering recipes (<filename>.bb</filename> files), removing 157 Recipe changes include altering recipes (<filename>.bb</filename> files), removing
@@ -165,10 +196,10 @@
165 Disk image.</para></listitem> 196 Disk image.</para></listitem>
166 <listitem><para><emphasis>Minimal RAM-based Initial Root Filesystem</emphasis> – 197 <listitem><para><emphasis>Minimal RAM-based Initial Root Filesystem</emphasis> –
167 A minimal image 198 A minimal image
168 that has the <filename>initramfs</filename> as part of the kernel, which allows the 199 that has the <filename>initramfs</filename> as part of the kernel, which allows the
169 system to find the first “init” program more efficiently.</para></listitem> 200 system to find the first “init” program more efficiently.</para></listitem>
170 <listitem><para><emphasis>Minimal Live</emphasis> – A Minimal Live image.</para></listitem> 201 <listitem><para><emphasis>Minimal Live</emphasis> – A Minimal Live image.</para></listitem>
171 <listitem><para><emphasis>Minimal MTD Utilities</emphasis> – A minimal image that has support 202 <listitem><para><emphasis>Minimal MTD Utilities</emphasis> – A minimal image that has support
172 for the MTD utilities, which let the user interact with the MTD subsystem in 203 for the MTD utilities, which let the user interact with the MTD subsystem in
173 the kernel to perform operations on flash devices.</para></listitem> 204 the kernel to perform operations on flash devices.</para></listitem>
174 <listitem><para><emphasis>Sato</emphasis> – An image with Sato support, a mobile environment 205 <listitem><para><emphasis>Sato</emphasis> – An image with Sato support, a mobile environment
@@ -183,7 +214,7 @@
183 <listitem><para><emphasis>Sato SDK Direct Disk</emphasis> – A Sato SDK Direct 214 <listitem><para><emphasis>Sato SDK Direct Disk</emphasis> – A Sato SDK Direct
184 Disk image.</para></listitem> 215 Disk image.</para></listitem>
185 <listitem><para><emphasis>Sato SDK Live</emphasis> – A Sato SDK Live 216 <listitem><para><emphasis>Sato SDK Live</emphasis> – A Sato SDK Live
186 image.</para></listitem> 217 image.</para></listitem>
187 </itemizedlist> 218 </itemizedlist>
188 </para></listitem> 219 </para></listitem>
189 </orderedlist> 220 </orderedlist>
@@ -198,11 +229,11 @@
198 Finally, there is wiki page write up of the example located 229 Finally, there is wiki page write up of the example located
199 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'> 230 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'>
200 here</ulink> you might find helpful. 231 here</ulink> you might find helpful.
201 </para> 232 </para>
202 </section> 233 </section>
203 234
204 <section id='place-holder-section-two'> 235 <section id='place-holder-section-kernel-development-model'>
205 <title>Place-Holder Section For Application Development</title> 236 <title>Place-Holder Section For Kernel Development Model</title>
206 237
207 <para> 238 <para>
208 Text needed here. 239 Text needed here.
@@ -210,6 +241,14 @@
210 </section> 241 </section>
211</section> 242</section>
212 243
244<section id='place-holder-section-two'>
245 <title>Place-Holder Section For Application Development</title>
246
247 <para>
248 Text needed here.
249 </para>
250</section>
251
213</chapter> 252</chapter>
214<!-- 253<!--
215vim: expandtab tw=80 ts=4 254vim: expandtab tw=80 ts=4