diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2010-12-15 14:37:33 -0800 |
---|---|---|
committer | Richard Purdie <rpurdie@linux.intel.com> | 2010-12-21 12:49:45 +0000 |
commit | 8e947f92ad619519595838873a0a6c88cdea8904 (patch) | |
tree | cf582b78d1a4cb73070cb95769dda0bc0dbd26c9 | |
parent | 27ff33fce5f823d8908a78241b92f6f0024a6bac (diff) | |
download | poky-8e947f92ad619519595838873a0a6c88cdea8904.tar.gz |
documentation/bsp-guide/bsp.xml: Changed numbering scheme.
It makes more sense to have the sections that describe the various
parts of the common structure as sub-sections to that. That pulls
out the click-through licensing into a higher-level section.
This is better overall section organization.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
-rw-r--r-- | documentation/bsp-guide/bsp.xml | 47 |
1 files changed, 23 insertions, 24 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 37e7fe8148..8518bf06d4 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml | |||
@@ -115,9 +115,7 @@ meta-crownbay/recipes-kernel/linux/linux-wrs_git.bbappend | |||
115 | The following sections describe each part of the proposed BSP format. | 115 | The following sections describe each part of the proposed BSP format. |
116 | </para> | 116 | </para> |
117 | 117 | ||
118 | </section> | 118 | <section id="bsp-filelayout-license"> |
119 | |||
120 | <section id="bsp-filelayout-license"> | ||
121 | <title>License Files</title> | 119 | <title>License Files</title> |
122 | <programlisting> | 120 | <programlisting> |
123 | meta-<bsp_name>/<bsp_license_file> | 121 | meta-<bsp_name>/<bsp_license_file> |
@@ -134,9 +132,9 @@ meta-<bsp_name>/<bsp_license_file> | |||
134 | Licensing files can be MIT, BSD, GPLv*, and so forth. | 132 | Licensing files can be MIT, BSD, GPLv*, and so forth. |
135 | These files are recommended for the BSP but are optional and totally up to the BSP developer. | 133 | These files are recommended for the BSP but are optional and totally up to the BSP developer. |
136 | </para> | 134 | </para> |
137 | </section> | 135 | </section> |
138 | 136 | ||
139 | <section id="bsp-filelayout-readme"> | 137 | <section id="bsp-filelayout-readme"> |
140 | <title>README File</title> | 138 | <title>README File</title> |
141 | <programlisting> | 139 | <programlisting> |
142 | meta-<bsp_name>/README | 140 | meta-<bsp_name>/README |
@@ -153,9 +151,9 @@ meta-<bsp_name>/README | |||
153 | Technically speaking a <filename>README</filename> is optional but it is highly | 151 | Technically speaking a <filename>README</filename> is optional but it is highly |
154 | recommended that every BSP has one. | 152 | recommended that every BSP has one. |
155 | </para> | 153 | </para> |
156 | </section> | 154 | </section> |
157 | 155 | ||
158 | <section id="bsp-filelayout-binary"> | 156 | <section id="bsp-filelayout-binary"> |
159 | <title>Pre-built User Binaries</title> | 157 | <title>Pre-built User Binaries</title> |
160 | <programlisting> | 158 | <programlisting> |
161 | meta-<bsp_name>/binary/<bootable_images> | 159 | meta-<bsp_name>/binary/<bootable_images> |
@@ -177,9 +175,9 @@ meta-<bsp_name>/binary/<bootable_images> | |||
177 | If pre-built binaries are present, source code to meet licensing requirements must also | 175 | If pre-built binaries are present, source code to meet licensing requirements must also |
178 | be provided in some form. | 176 | be provided in some form. |
179 | </para> | 177 | </para> |
180 | </section> | 178 | </section> |
181 | 179 | ||
182 | <section id='bsp-filelayout-layer'> | 180 | <section id='bsp-filelayout-layer'> |
183 | <title>Layer Configuration File</title> | 181 | <title>Layer Configuration File</title> |
184 | <programlisting> | 182 | <programlisting> |
185 | meta-<bsp_name>/conf/layer.conf | 183 | meta-<bsp_name>/conf/layer.conf |
@@ -209,9 +207,9 @@ BBFILE_PRIORITY_bsp = "5" | |||
209 | This file simply makes BitBake aware of the recipes and configuration directories. | 207 | This file simply makes BitBake aware of the recipes and configuration directories. |
210 | This file must exist so that Poky can recognize the BSP. | 208 | This file must exist so that Poky can recognize the BSP. |
211 | </para> | 209 | </para> |
212 | </section> | 210 | </section> |
213 | 211 | ||
214 | <section id="bsp-filelayout-machine"> | 212 | <section id="bsp-filelayout-machine"> |
215 | <title>Hardware Configuration Options</title> | 213 | <title>Hardware Configuration Options</title> |
216 | <programlisting> | 214 | <programlisting> |
217 | meta-<bsp_name>/conf/machine/*.conf | 215 | meta-<bsp_name>/conf/machine/*.conf |
@@ -262,9 +260,9 @@ TARGET_CC_ARCH = "-m32 -march=core2 -msse3 -mtune=generic -mfpmath=sse" | |||
262 | <para> | 260 | <para> |
263 | Both the base package architecuture file and the tune file are optional for a Poky BSP layer. | 261 | Both the base package architecuture file and the tune file are optional for a Poky BSP layer. |
264 | </para> | 262 | </para> |
265 | </section> | 263 | </section> |
266 | 264 | ||
267 | <section id='bsp-filelayout-misc-recipes'> | 265 | <section id='bsp-filelayout-misc-recipes'> |
268 | <title>Miscellaneous Recipe Files</title> | 266 | <title>Miscellaneous Recipe Files</title> |
269 | <programlisting> | 267 | <programlisting> |
270 | meta-<bsp_name>/recipes-bsp/* | 268 | meta-<bsp_name>/recipes-bsp/* |
@@ -280,9 +278,9 @@ meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay/machconfig | |||
280 | meta-crownbay/recipes-bsp/formfactor/formfactor_0.0.bbappend | 278 | meta-crownbay/recipes-bsp/formfactor/formfactor_0.0.bbappend |
281 | </programlisting> | 279 | </programlisting> |
282 | </para> | 280 | </para> |
283 | </section> | 281 | </section> |
284 | 282 | ||
285 | <section id='bsp-filelayout-recipes-graphics'> | 283 | <section id='bsp-filelayout-recipes-graphics'> |
286 | <title>Display Support Files</title> | 284 | <title>Display Support Files</title> |
287 | <programlisting> | 285 | <programlisting> |
288 | meta-<bsp_name>/recipes-graphics/* | 286 | meta-<bsp_name>/recipes-graphics/* |
@@ -304,9 +302,9 @@ meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd/nodolt.patch | |||
304 | meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd_1.7.99.2.bb | 302 | meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd_1.7.99.2.bb |
305 | </programlisting> | 303 | </programlisting> |
306 | </para> | 304 | </para> |
307 | </section> | 305 | </section> |
308 | 306 | ||
309 | <section id='bsp-filelayout-kernel'> | 307 | <section id='bsp-filelayout-kernel'> |
310 | <title>Linux Kernel Configuration</title> | 308 | <title>Linux Kernel Configuration</title> |
311 | <programlisting> | 309 | <programlisting> |
312 | meta-<bsp_name>/recipes-kernel/linux/linux-wrs_git.bbappend | 310 | meta-<bsp_name>/recipes-kernel/linux/linux-wrs_git.bbappend |
@@ -353,9 +351,9 @@ meta-emenlow/recipes-kernel/linux/linux-bsp-2.6.50/defconfig-bsp | |||
353 | Examples of kernel recipes are available in Poky itself, and thus, make these files optional. | 351 | Examples of kernel recipes are available in Poky itself, and thus, make these files optional. |
354 | However, it would be unusual not to have a kernel configuration. | 352 | However, it would be unusual not to have a kernel configuration. |
355 | </para> | 353 | </para> |
356 | </section> | 354 | </section> |
357 | 355 | ||
358 | <!-- <section id='bsp-filelayout-packages'> | 356 | <!-- <section id='bsp-filelayout-packages'> |
359 | <title>Other Software (meta-<bsp_name>/recipes-kernel/*)</title> | 357 | <title>Other Software (meta-<bsp_name>/recipes-kernel/*)</title> |
360 | 358 | ||
361 | <para> | 359 | <para> |
@@ -400,9 +398,9 @@ meta-Emenlow/recipes-Emenlow/modem/modem-daemon_0.1.bb | |||
400 | meta-Emenlow/recipes-Emenlow/image-creator/image-creator-native_0.1.bb | 398 | meta-Emenlow/recipes-Emenlow/image-creator/image-creator-native_0.1.bb |
401 | </programlisting> | 399 | </programlisting> |
402 | </para> | 400 | </para> |
403 | </section> | 401 | </section> |
404 | 402 | ||
405 | <section id='bs-filelayout-bbappend'> | 403 | <section id='bs-filelayout-bbappend'> |
406 | <title>Append BSP-Specific Information to Existing Recipes</title> | 404 | <title>Append BSP-Specific Information to Existing Recipes</title> |
407 | <para> | 405 | <para> |
408 | Suppose you have a recipe such as "pointercal" that requires machine-specific information. | 406 | Suppose you have a recipe such as "pointercal" that requires machine-specific information. |
@@ -432,9 +430,9 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}" | |||
432 | which will be picked up by BitBake. | 430 | which will be picked up by BitBake. |
433 | For an example see <filename>meta-emenlow/packages/formfactor</filename>. | 431 | For an example see <filename>meta-emenlow/packages/formfactor</filename>. |
434 | </para> | 432 | </para> |
435 | </section> | 433 | </section> |
436 | 434 | ||
437 | <section id="bsp-filelayout-prebuilds"> | 435 | <section id="bsp-filelayout-prebuilds"> |
438 | <title>Pre-build Data (meta-<bsp_name>/prebuilds/*)</title> | 436 | <title>Pre-build Data (meta-<bsp_name>/prebuilds/*)</title> |
439 | <para> | 437 | <para> |
440 | This location can contain precompiled representations of the source code | 438 | This location can contain precompiled representations of the source code |
@@ -442,7 +440,8 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}" | |||
442 | Assuming a compatible configuration is used, Poky can process and use these optional pre-compiled | 440 | Assuming a compatible configuration is used, Poky can process and use these optional pre-compiled |
443 | representations to provide much faster build times. | 441 | representations to provide much faster build times. |
444 | </para> | 442 | </para> |
445 | </section> --> | 443 | </section> --> |
444 | </section> | ||
446 | 445 | ||
447 | <section id='bsp-click-through-licensing'> | 446 | <section id='bsp-click-through-licensing'> |
448 | <title>BSP 'Click-Through' Licensing Procedure</title> | 447 | <title>BSP 'Click-Through' Licensing Procedure</title> |