[PATCH] yocto-docs: Various cleanup/tweaking to BSP Guide


Robert P. J. Day
 

Collection of minor cleanups to BSP Guide:

* Standardize on spelling of "BSP layer" rather than "BSP Layer"
* Describe YP reference boards in more detail (architecture, ...)
* Bump up several references to kernel "4.4" to "4.9"
* Replace meaningless "bsp_name.conf" with "machine.conf"
* Add a few more sample components to the BSP layer structure

Signed-off-by: Robert P. J. Day <rpjday@...>

---

diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 4d0ace0..d81cb46 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -19,7 +19,7 @@
</para>

<para>
- This guide presents information about BSP Layers, defines a structure for components
+ This guide presents information about BSP layers, defines a structure for components
so that BSPs follow a commonly understood layout, discusses how to customize
a recipe for a BSP, addresses BSP licensing, and provides information that
shows you how to create and manage a
@@ -33,7 +33,7 @@
<para>
A BSP consists of a file structure inside a base directory.
Collectively, you can think of the base directory, its file structure,
- and the contents as a BSP Layer.
+ and the contents as a BSP layer.
Although not a strict requirement, layers in the Yocto Project use the
following well-established naming convention:
<literallayout class='monospaced'>
@@ -77,8 +77,10 @@
<filename>meta-yocto-bsp</filename> layer is part of the
shipped <filename>poky</filename> repository.
The <filename>meta-yocto-bsp</filename> layer maintains several
- BSPs such as the Beaglebone, EdgeRouter, and generic versions of
- both 32 and 64-bit IA machines.
+ BSPs such as the ARM-based Beaglebone,
+ MIPS64-based Ubiquiti Networks EdgeRouter,
+ PowerPC-based Freescale MPC8315E-RDB,
+ and generic versions of both 32 and 64-bit IA machines.
</para>

<para>
@@ -94,7 +96,7 @@
<para>
The layer's base directory
(<filename>meta-<replaceable>bsp_name</replaceable></filename>)
- is the root of the BSP Layer.
+ is the root of the BSP layer.
This root is what you add to the
<ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink>
variable in the <filename>conf/bblayers.conf</filename> file found in the
@@ -189,7 +191,7 @@

<para>
Below is the common form for the file structure inside a BSP Layer.
- While you can use this basic form for the standard, realize that the actual structures
+ While you can use this basic form as your standard, realize that the actual structures
for specific BSPs could differ.

<literallayout class='monospaced'>
@@ -200,6 +202,9 @@
meta-<replaceable>bsp_name</replaceable>/binary/<replaceable>bootable_images</replaceable>
meta-<replaceable>bsp_name</replaceable>/conf/layer.conf
meta-<replaceable>bsp_name</replaceable>/conf/machine/*.conf
+ meta-<replaceable>bsp_name</replaceable>/conf/machine/include/*
+ meta-<replaceable>bsp_name</replaceable>/files/*
+ meta-<replaceable>bsp_name</replaceable>/classes/*
meta-<replaceable>bsp_name</replaceable>/recipes-bsp/*
meta-<replaceable>bsp_name</replaceable>/recipes-core/*
meta-<replaceable>bsp_name</replaceable>/recipes-graphics/*
@@ -663,21 +668,21 @@
the <filename>meta-<replaceable>bsp_name</replaceable>/recipes-kernel/linux</filename> directory).
</para>
<para>
- Suppose you are using the <filename>linux-yocto_4.4.bb</filename> recipe to build
+ Suppose you are using the <filename>linux-yocto_4.9.bb</filename> recipe to build
the kernel.
In other words, you have selected the kernel in your
- <replaceable>bsp_name</replaceable><filename>.conf</filename> file by adding these types
+ <replaceable>machine</replaceable><filename>.conf</filename> file by adding these types
of statements:
<literallayout class='monospaced'>
PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto"
- PREFERRED_VERSION_linux-yocto ?= "4.4%"
+ PREFERRED_VERSION_linux-yocto ?= "4.9%"
</literallayout>
<note>
When the preferred provider is assumed by default, the
<filename>PREFERRED_PROVIDER</filename> statement does not appear in the
- <replaceable>bsp_name</replaceable><filename>.conf</filename> file.
+ <replaceable>machine</replaceable><filename>.conf</filename> file.
</note>
- You would use the <filename>linux-yocto_4.4.bbappend</filename>
+ You would then create a <filename>linux-yocto_4.9.bbappend</filename>
file to append specific BSP settings to the kernel, thus
configuring the kernel for your particular BSP.
</para>
@@ -686,7 +691,7 @@
As an example, consider the following append file
used by the BSPs in <filename>meta-yocto-bsp</filename>:
<literallayout class='monospaced'>
- meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.4.bbappend
+ meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.9.bbappend
</literallayout>
The following listing shows the file.
Be aware that the actual commit ID strings in this

--

========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca

Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================

Join yocto@lists.yoctoproject.org to automatically receive all group messages.