[PATCH 0/3] yocto-docs/bsp-guide: update BSP layers-related sections

[PATCH 0/3] yocto-docs/bsp-guide: update BSP layers-related sections

[tom.zanussi]

From: Tom Zanussi <tom.zanussi@intel.com>

The BSP Layers section of the BSP Guide contained some example layers
that don't really belong in a generic guide - this patchset removes
them, and updates the related README section.

It also updates the README.sources section, which I noticed shouldn't
really be optional.

The following changes since commit 18c537d96bde8fac7f62071585b71aed05037410:
  Scott Rifenbark (1):
        documentation/poky-ref-manual/development.xml: another env var clarification

are available in the git repository at:

  git://git.yoctoproject.org/poky-contrib.git tzanussi/yocto-docs-bsp-layers-updates
  http://git.yoctoproject.org/cgit.cgi//log/?h=tzanussi/yocto-docs-bsp-layers-updates

Tom Zanussi (3):
  documentation/bsp-guide/bsp.xml: remove mention of specific BSPs
  documentation/bsp-guide/bsp.xml: update the README section
  documentation/bsp-guide/bsp.xml: make README.sources non-optional

 documentation/bsp-guide/bsp.xml |   49 ++++++++++++--------------------------
 1 files changed, 16 insertions(+), 33 deletions(-)

[PATCH 1/3] documentation/bsp-guide/bsp.xml: remove mention of specific BSPs

[tom.zanussi]

From: Tom Zanussi <tom.zanussi@intel.com>

Some of these aren't even BSP layers, but nonetheless remove the
mention of specific layers as examples in this section, which should
be a more generic section.

Also add a note that additional layers may be needed by certain BSPs.

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
---
 documentation/bsp-guide/bsp.xml |   38 ++++++++++++--------------------------
 1 files changed, 12 insertions(+), 26 deletions(-)

diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index f088f30..0b32acc 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -76,32 +76,6 @@
             </para>
 
             <para>
-                The Yocto Project organizes BSP Layers within the Yocto Metadata Layers area 
-                of the Yocto Project Source Repositories at 
-                <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.
-                If you examine the source repositories, you will find many BSP Layers.
-                Here are a few:
-                <literallayout class='monospaced'>
-     meta-baryon
-     meta-fsl-ppc
-     meta-intel
-     meta-selinux
-     meta-ti
-                </literallayout>
-                It is worth noting that the <filename>meta-intel</filename> BSP Layer contains 
-                within itself several other BSP Layers, which makes it sort of a "super" BSP layer.
-                Following is a sampling of the BSP Layers that the <filename>meta-intel</filename> 
-                BSP Layer contains:
-                <literallayout class='monospaced'>
-     meta-cedartrail
-     meta-crownbay
-     meta-emenlow
-     meta-fishriver
-     meta-fri2
-                </literallayout>
-            </para>
-
-            <para>
                 The layer's base directory (<filename>meta-&lt;bsp_name&gt;</filename>) is the root 
                 of the BSP Layer.
                 This root is what you add to the <filename>BBLAYERS</filename>
@@ -120,6 +94,18 @@
             </para>
 
             <para>
+                Note that some BSPs may require additional layers on
+                top of the BSP's root layer in order to be functional.
+                Those layers would also need to be added to the
+                BBLAYERS variable in order to build the BSP.  Any
+                requirements for additional layers must be specified
+                in the 'Dependencies' section of the BSP's README
+                file, and preferably also mentioned explicitly in any
+                build instructions that might be contained elsewhere
+                in the README file.
+            </para>
+
+            <para>
                 For more detailed information on layers, see the 
                 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" 
                 section of the Yocto Project Development Manual.
-- 
1.7.0.4

[PATCH 2/3] documentation/bsp-guide/bsp.xml: update the README section

[tom.zanussi]

From: Tom Zanussi <tom.zanussi@intel.com>

The README section should not be optional, since at minumum it needs
to contain layer dependencies and maintainer info.

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
---
 documentation/bsp-guide/bsp.xml |    6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 0b32acc..51787f3 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -220,8 +220,10 @@
             </para>
 
             <para>
-                Technically speaking a <filename>README</filename> file is optional but it is highly 
-                recommended that every BSP has one.
+                At minimum, the <filename>README</filename> file must
+                contain a list of dependencies, such as the names of
+                any other layers the BSP depends on, and the name of
+                the BSP maintainer and his or her contact information.
             </para>
             </section>
 
-- 
1.7.0.4

[PATCH 3/3] documentation/bsp-guide/bsp.xml: make README.sources non-optional

[tom.zanussi]

From: Tom Zanussi <tom.zanussi@intel.com>

Any shipped BSP needs this file for legal reasons, thus it's
non-optional.

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
---
 documentation/bsp-guide/bsp.xml |    5 -----
 1 files changed, 0 insertions(+), 5 deletions(-)

diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 51787f3..623192c 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -243,11 +243,6 @@
                 Information is also included to help you find the metadata used to generate the images
                 that ship with the BSP.
             </para>
-
-            <para>
-                Technically speaking a <filename>README.sources</filename> file is optional but it is highly 
-                recommended that every BSP has one.
-            </para>
             </section>
 
             <section id="bsp-filelayout-binary">
-- 
1.7.0.4