summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2010-11-09 08:59:36 -0800
committerRichard Purdie <rpurdie@linux.intel.com>2010-11-15 22:25:24 +0000
commit7066eff0bdb012643a3f529d6030054bf18e375f (patch)
treeff2158356d017f57a88001d5f74591b5c36af644 /documentation
parentd7f70e0c20148c477ede0129846673e9c8bee611 (diff)
downloadpoky-7066eff0bdb012643a3f529d6030054bf18e375f.tar.gz
BSP Developers Guide: Edits to text
I made several spelling corrections and rewrote a sentence or two for better structure. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/bsp-guide/bsp.xml51
1 files changed, 26 insertions, 25 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 3b4b4818fa..599c2bf060 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -30,9 +30,9 @@
30 The proposed format does have elements that are specific to the Poky and 30 The proposed format does have elements that are specific to the Poky and
31 OpenEmbedded build systems. 31 OpenEmbedded build systems.
32 It is intended that this information can be 32 It is intended that this information can be
33 used by other systems besides Poky and OpenEmbedded and thatspecified it will be simple 33 used by other systems besides Poky and OpenEmbedded and that it will be simple
34 to extract information and convert it to other formats if required. 34 to extract information and convert it to other formats if required.
35 Poky, through its standard slyers mechanism, can directly accept The format 35 Poky, through its standard layers mechanism, can directly accept The format
36 described as a layer. 36 described as a layer.
37 The BSP captures all 37 The BSP captures all
38 the hardware specific details in one place in a standard format, which is 38 the hardware specific details in one place in a standard format, which is
@@ -44,7 +44,7 @@
44 The BSP specification does not include a build system or other tools - 44 The BSP specification does not include a build system or other tools -
45 it is concerned with the hardware-specific components only. 45 it is concerned with the hardware-specific components only.
46 At the end 46 At the end
47 distribution point you can shipt the BSP combined with a build system 47 distribution point you can ship the BSP combined with a build system
48 and other tools. 48 and other tools.
49 However, it is important to maintain the distinction that these 49 However, it is important to maintain the distinction that these
50 are separate components that happen to be combined in certain end products. 50 are separate components that happen to be combined in certain end products.
@@ -193,7 +193,7 @@
193 <para> 193 <para>
194 These files make up the definition of a kernel to use with this 194 These files make up the definition of a kernel to use with this
195 hardware. 195 hardware.
196 In this case it is a complete self-contained kernel with its own 196 In this case, it is a complete self-contained kernel with its own
197 configuration and patches but kernels can be shared between many 197 configuration and patches but kernels can be shared between many
198 machines as well. 198 machines as well.
199 Following is an example: 199 Following is an example:
@@ -326,33 +326,32 @@
326 <section id='bsp-click-through-licensing'> 326 <section id='bsp-click-through-licensing'>
327 <title>BSP 'Click-Through' Licensing Procedure</title> 327 <title>BSP 'Click-Through' Licensing Procedure</title>
328 328
329 <note><para> This section is here as a description of how 329 <note><para> This section describes how
330 click-through licensing is expected to work, and is 330 click-through licensing, which is not yet implemented, is expected to work.
331 not yet not impemented.
332 </para></note> 331 </para></note>
333 332
334 <para> 333 <para>
335 In some cases, a BSP may contain separately licensed IP 334 In some cases, a BSP might contain separately licensed IP
336 (Intellectual Property) for a component, which imposes 335 (Intellectual Property) for a component that imposes
337 upon the user a requirement to accept the terms of a 336 upon the user a requirement to accept the terms of a
338 'click-through' license. Once the license is accepted 337 'click-through' license. Once the license is accepted
339 (in whatever form that may be, see details below) the 338 (in whatever form that may be, see details below) the
340 Poky build system can then build and include the 339 Poky build system can then build and include the
341 corresponding component in the final BSP image. Some 340 corresponding component in the final BSP image. Some
342 affected components may be essential to the normal 341 affected components might be essential to the normal
343 functioning of the system and have no 'free' replacement 342 functioning of the system and have no 'free' replacement
344 i.e. the resulting system would be non-functional 343 (i.e. the resulting system would be non-functional
345 without them. Other components may be simply 344 without them). Other components might be simply
346 'good-to-have' or purely elective, or if essential 345 'good-to-have' or purely elective, or if essential
347 nonetheless have a 'free' (possibly less-capable) 346 nonetheless have a 'free' (possibly less-capable)
348 version which may substituted for in the BSP recipe. 347 version that can be substituted for in the BSP recipe.
349 </para> 348 </para>
350 349
351 <para> 350 <para>
352 For the latter cases, where it is possible to do so from 351 For the latter cases, where it is possible to do so from
353 a functionality perspective, the Poky website will make 352 a functionality perspective, the Poky website will make
354 available a 'de-featured' BSP completely free of 353 available a 'de-featured' BSP completely free of
355 encumbered IP, which can be used directly and without 354 encumbered IP that can be used directly and without
356 any further licensing requirements. If present, this 355 any further licensing requirements. If present, this
357 fully 'de-featured' BSP will be named meta-bsp (i.e. the 356 fully 'de-featured' BSP will be named meta-bsp (i.e. the
358 normal default naming convention). This is the simplest 357 normal default naming convention). This is the simplest
@@ -361,7 +360,7 @@
361 </para> 360 </para>
362 361
363 <para> 362 <para>
364 If however, a non-encumbered version is unavailable or 363 However, if a non-encumbered version is unavailable or
365 the 'free' version would provide unsuitable 364 the 'free' version would provide unsuitable
366 functionality or quality, an encumbered version can be 365 functionality or quality, an encumbered version can be
367 used. Encumbered versions of a BSP are given names of 366 used. Encumbered versions of a BSP are given names of
@@ -410,12 +409,12 @@
410 <para> 409 <para>
411 The &lt;keydomain&gt; component of the 410 The &lt;keydomain&gt; component of the
412 BSPKEY_&lt;keydomain&gt; is required because there 411 BSPKEY_&lt;keydomain&gt; is required because there
413 may be multiple licenses in effect for a give BSP; a 412 may be multiple licenses in effect for a given BSP; a
414 given &lt;keydomain&gt; in such cases corresponds to 413 given &lt;keydomain&gt; in such cases corresponds to
415 a particular license. In order for an encumbered 414 a particular license. In order for an encumbered
416 BSP encompassing multiple key domains to be built 415 BSP encompassing multiple key domains to be built
417 successfully, a &lt;keydomain&gt; entry for each 416 successfully, a &lt;keydomain&gt; entry for each
418 applicable license must be present in local.conf or 417 applicable license must be present in <filename>local.conf</filename> or
419 supplied on the command-line. 418 supplied on the command-line.
420 </para> 419 </para>
421 </listitem> 420 </listitem>
@@ -426,8 +425,8 @@
426 encumbered BSP (the build will cleanly stop at this 425 encumbered BSP (the build will cleanly stop at this
427 point). These usually take the form of instructions 426 point). These usually take the form of instructions
428 needed to manually fetch the encumbered package(s) 427 needed to manually fetch the encumbered package(s)
429 and md5 sums into e.g. the poky/build/downloads 428 and md5 sums into the directory (e.g. the poky/build/downloads).
430 directory. Once the manual package fetch has been 429 Once the manual package fetch has been
431 completed, restarting the build will continue where 430 completed, restarting the build will continue where
432 it left off, this time without the prompt since the 431 it left off, this time without the prompt since the
433 license requirements will have been satisfied. 432 license requirements will have been satisfied.
@@ -448,12 +447,14 @@
448 </para> 447 </para>
449 </listitem> 448 </listitem>
450 </itemizedlist> 449 </itemizedlist>
451 <para> 450 <note>
452 Note that method 3 is also the only option available 451 <para>
453 when downloading pre-compiled images generated from 452 Note that method 3 is also the only option available
454 non-free BSPs. Those images are likewise available at 453 when downloading pre-compiled images generated from
455 <ulink url='https://pokylinux.org/bsps.html'>https://pokylinux.org/bsps.html</ulink>. 454 non-free BSPs. Those images are likewise available at
456 </para> 455 <ulink url='https://pokylinux.org/bsps.html'>https://pokylinux.org/bsps.html</ulink>.
456 </para>
457 </note>
457 </section> 458 </section>
458 459
459</chapter> 460</chapter>