Skip to contentSkip to conversation

yocto-docs: Minor, aesthetic touchups to BSP Guide.

PATCH New Robert P. J. Day 1 participant 1 message Dec 30, 2014

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 yocto-docs: Minor, aesthetic touchups to BSP Guide.

---

documentation/bsp-guide/bsp.xml +9 -8
index d485023..2f5a2cc 100644
@@ -35,12 +35,12 @@
                 Collectively, you can think of the base directory, its file structure,
                 and the contents as a BSP Layer.
                 Although not a strict requirement, layers in the Yocto Project use the
-                following well established naming convention:
+                following well-established naming convention:
                 <literallayout class='monospaced'>
      meta-<replaceable>bsp_name</replaceable>
                 </literallayout>
                 The string "meta-" is prepended to the machine or platform name, which is
-                "bsp_name" in the above form.
+                <replaceable>bsp_name</replaceable> in the above form.
             </para>
 
             <para>
@@ -58,7 +58,7 @@
                 Each of these layers is a repository unto itself and clicking on a
                 layer reveals information that includes two links from which you can choose
                 to set up a clone of the layer's repository on your local host system.
-                Here is an example that clones the Minnow Board BSP layer:
+                Here is an example that clones the MinnowBoard BSP layer:
                 <literallayout class='monospaced'>
      $ git clone git://git.yoctoproject.org/meta-minnow
                 </literallayout>
@@ -115,8 +115,9 @@
 
             <para>
                 Some layers function as a layer to hold other BSP layers.
-                An example of this type of layer is the <filename>meta-intel</filename> layer.
-                The <filename>meta-intel</filename> layer contains many individual BSP layers.
+                An example of this type of layer is the <filename>meta-intel</filename> layer,
+                which contains a number of individual BSP sub-layers, as well as a directory
+                named <filename>common/</filename> full of common content across those layers.
             </para>
 
             <para>
@@ -131,8 +132,8 @@
             <title>Example Filesystem Layout</title>
 
             <para>
-                Providing a common form allows end-users to understand and become familiar
-                with the layout.
+                Defining a common BSP directory structure allows end-users to understand and
+                become familiar with that structure.
                 A common format also encourages standardization of software support of hardware.
             </para>
 
@@ -501,7 +502,7 @@
             <para>
                 You can find these files in the BSP Layer at:
                 <literallayout class='monospaced'>
-     meta-<replaceable>bsp_name</replaceable>/recipes-kernel/linux/linux-yocto_*.bbappend
+     meta-<replaceable>bsp_name</replaceable>/recipes-kernel/linux/linux-yocto*.bbappend
                 </literallayout>
             </para>
 
Signature · 7 lines
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

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