All of lore.kernel.org
 help / color / mirror / Atom feed
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
To: poky@yoctoproject.org
Subject: [PATCH 20/29] documentation/bsp-guide/bsp.xml: Changed numbering scheme.
Date: Wed, 15 Dec 2010 14:37:33 -0800	[thread overview]
Message-ID: <bd8f8a35a4bfd9b96c92afa07e211a981c2ff452.1292876262.git.scott.m.rifenbark@intel.com> (raw)
In-Reply-To: <cover.1292876262.git.scott.m.rifenbark@intel.com>

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>
---
 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 37e7fe8..8518bf0 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
                 The following sections describe each part of the proposed BSP format.
             </para>
 
-        </section>
-
-        <section id="bsp-filelayout-license">
+            <section id="bsp-filelayout-license">
             <title>License Files</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/&lt;bsp_license_file&gt;
@@ -134,9 +132,9 @@ meta-&lt;bsp_name&gt;/&lt;bsp_license_file&gt;
                 Licensing files can be MIT, BSD, GPLv*, and so forth.
                 These files are recommended for the BSP but are optional and totally up to the BSP developer.
             </para>
-        </section>
+            </section>
 
-        <section id="bsp-filelayout-readme">
+            <section id="bsp-filelayout-readme">
             <title>README File</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/README
@@ -153,9 +151,9 @@ meta-&lt;bsp_name&gt;/README
                 Technically speaking a <filename>README</filename> is optional but it is highly 
                 recommended that every BSP has one.
             </para>
-        </section>
+            </section>
 
-        <section id="bsp-filelayout-binary">
+            <section id="bsp-filelayout-binary">
             <title>Pre-built User Binaries</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/binary/&lt;bootable_images&gt;
@@ -177,9 +175,9 @@ meta-&lt;bsp_name&gt;/binary/&lt;bootable_images&gt;
                 If pre-built binaries are present, source code to meet licensing requirements must also 
                 be provided in some form.
             </para>
-        </section>
+            </section>
 
-        <section id='bsp-filelayout-layer'>
+            <section id='bsp-filelayout-layer'>
             <title>Layer Configuration File</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/conf/layer.conf 
@@ -209,9 +207,9 @@ BBFILE_PRIORITY_bsp = "5"
                 This file simply makes BitBake aware of the recipes and configuration directories.
                 This file must exist so that Poky can recognize the BSP.
             </para>
-        </section>
+            </section>
 
-        <section id="bsp-filelayout-machine">
+            <section id="bsp-filelayout-machine">
             <title>Hardware Configuration Options</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/conf/machine/*.conf
@@ -262,9 +260,9 @@ TARGET_CC_ARCH = "-m32 -march=core2 -msse3 -mtune=generic -mfpmath=sse"
             <para>
                 Both the base package architecuture file and the tune file are optional for a Poky BSP layer.
             </para>
-        </section>
+            </section>
 
-        <section id='bsp-filelayout-misc-recipes'>
+            <section id='bsp-filelayout-misc-recipes'>
             <title>Miscellaneous Recipe Files</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/recipes-bsp/*
@@ -280,9 +278,9 @@ meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay/machconfig
 meta-crownbay/recipes-bsp/formfactor/formfactor_0.0.bbappend
                 </programlisting>
             </para>
-        </section>
+            </section>
 
-        <section id='bsp-filelayout-recipes-graphics'>
+            <section id='bsp-filelayout-recipes-graphics'>
             <title>Display Support Files</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/recipes-graphics/*            
@@ -304,9 +302,9 @@ meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd/nodolt.patch
 meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd_1.7.99.2.bb
                 </programlisting>
             </para>
-        </section>
+            </section>
 
-        <section id='bsp-filelayout-kernel'>
+            <section id='bsp-filelayout-kernel'>
             <title>Linux Kernel Configuration</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
@@ -353,9 +351,9 @@ meta-emenlow/recipes-kernel/linux/linux-bsp-2.6.50/defconfig-bsp
                 Examples of kernel recipes are available in Poky itself, and thus, make these files optional.
                 However, it would be unusual not to have a kernel configuration.
             </para>
-        </section>
+            </section>
 
-<!--        <section id='bsp-filelayout-packages'>
+<!--            <section id='bsp-filelayout-packages'>
             <title>Other Software (meta-&lt;bsp_name&gt;/recipes-kernel/*)</title>
 
             <para>
@@ -400,9 +398,9 @@ meta-Emenlow/recipes-Emenlow/modem/modem-daemon_0.1.bb
 meta-Emenlow/recipes-Emenlow/image-creator/image-creator-native_0.1.bb
                </programlisting>
             </para>
-        </section>
+            </section>
 
-        <section id='bs-filelayout-bbappend'>
+            <section id='bs-filelayout-bbappend'>
             <title>Append BSP-Specific Information to Existing Recipes</title>
             <para>
                 Suppose you have a recipe such as "pointercal" that requires machine-specific information.
@@ -432,9 +430,9 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}"
             which will be picked up by BitBake. 
             For an example see <filename>meta-emenlow/packages/formfactor</filename>.
             </para>
-        </section>
+            </section>
 
-        <section id="bsp-filelayout-prebuilds">
+            <section id="bsp-filelayout-prebuilds">
             <title>Pre-build Data (meta-&lt;bsp_name&gt;/prebuilds/*)</title>
             <para>
                 This location can contain precompiled representations of the source code 
@@ -442,7 +440,8 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}"
                 Assuming a compatible configuration is used, Poky can process and use these optional pre-compiled 
                 representations to provide much faster build times.
             </para>
-        </section> -->
+            </section> -->
+        </section>
 
         <section id='bsp-click-through-licensing'>
             <title>BSP 'Click-Through' Licensing Procedure</title>
-- 
1.7.0.4



  parent reply	other threads:[~2010-12-20 20:24 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-12-20 20:17 [PATCH 00/29] Docs - BSP Guide Updates for changes to the BSP template Scott Rifenbark
2010-12-15  0:45 ` [PATCH 01/29] documentation/bsp-guide/bsp.xml: Changed meta naming convention Scott Rifenbark
2010-12-15  0:54 ` [PATCH 02/29] documentation/bsp-guide/bsp.xml: Added note qualifying BSP file structure Scott Rifenbark
2010-12-15  0:56 ` [PATCH 03/29] documentation/bsp-guide/bsp.xml: Fixed typo Scott Rifenbark
2010-12-15  1:03 ` [PATCH 04/29] documentation/bsp-guide/bsp.xml: Added information about /binary Scott Rifenbark
2010-12-15  1:08 ` [PATCH 05/29] documentation/bsp-guide/bsp.xml: Created better BSP example base names Scott Rifenbark
2010-12-15 17:28 ` [PATCH 06/29] documentation/bsp-guide/bsp.xml: Inserted text before the file structure example Scott Rifenbark
2010-12-15 20:31 ` [PATCH 07/29] documentation/bsp-guide/bsp.xml: Updated common form for file structure Scott Rifenbark
2010-12-15 20:46 ` [PATCH 08/29] documentation/bsp-work/bsp.xml: Added crownbay BSP example to section 1.1 Scott Rifenbark
2010-12-15 20:56 ` [PATCH 09/29] documentation/bsp-guide/bsp.xml: Updated the introductary paragraph to the sections Scott Rifenbark
2010-12-15 21:11 ` [PATCH 10/29] documentation/bsp-guide/bsp.xml: Added new "License Files" section Scott Rifenbark
2010-12-15 21:19 ` [PATCH 11/29] documentation/bsp-guide/bsp.xml: Added the README section Scott Rifenbark
2010-12-15 21:26 ` [PATCH 12/29] documentation/bsp-guide/bsp.xml: Updated the Pre-built User Binaries section Scott Rifenbark
2010-12-15 21:40 ` [PATCH 13/29] documenation/bsp-guide/bsp.xml: Updated the Layer Configuration File section Scott Rifenbark
2010-12-15 22:00 ` [PATCH 14/29] documentation/bsp-guide/bsp.xml: Updated the Hardware Configuration Options section Scott Rifenbark
2010-12-15 22:13 ` [PATCH 15/29] documentation/bsp-guide/bsp.xml: Added a Miscellaneous Recipe Files section Scott Rifenbark
2010-12-15 22:15 ` [PATCH 16/29] documentation/bsp-guide/bsp.xml: Removed the recipes-bsp/formfactor directory from the common structure Scott Rifenbark
2010-12-15 22:25 ` [PATCH 17/29] documentation/bsp-guide/bsp.xml: Added a Display Support Files section Scott Rifenbark
2010-12-15 22:29 ` [PATCH 18/29] documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section Scott Rifenbark
2010-12-15 22:31 ` [PATCH 19/29] documentation/bsp-guide/bsp.xml: Commented out three sections Scott Rifenbark
2010-12-15 22:37 ` Scott Rifenbark [this message]
2010-12-16 21:39 ` [PATCH 21/29] documentation/bsp-guide/bsp.xml: Updated Layer Configuration File Section Scott Rifenbark
2010-12-16 21:54 ` [PATCH 22/29] documentation/bsp-guild/bsp.xml: Updated Miscellaneous Recipe Files section Scott Rifenbark
2010-12-16 21:58 ` [PATCH 23/29] documentation/bsp-guide/bsp.xml: Updated Display Support " Scott Rifenbark
2010-12-17 16:30 ` [PATCH 24/29] documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section Scott Rifenbark
2010-12-17 16:52 ` [PATCH 25/29] documentation/bsp-guide/bsp.xml: Added reference to Kernel documentation Scott Rifenbark
2010-12-17 22:53 ` [PATCH 26/29] documentation/bsp-guide/bsp.xml: Updated the Linux Kernel Configuration section Scott Rifenbark
2010-12-18  0:29 ` [PATCH 27/29] documentation/bsp-guide/bsp.xml: replaced the append file line in the template Scott Rifenbark
2010-12-18  0:53 ` [PATCH 28/29] documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section Scott Rifenbark
2010-12-18  0:59 ` [PATCH 29/29] documentation/bsp-guide/bsp.xml: Spell checked the file Scott Rifenbark
2010-12-21  7:28 ` [PATCH 00/29] Docs - BSP Guide Updates for changes to the BSP template Saul Wold
2010-12-21 12:51 ` Richard Purdie

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bd8f8a35a4bfd9b96c92afa07e211a981c2ff452.1292876262.git.scott.m.rifenbark@intel.com \
    --to=scott.m.rifenbark@intel.com \
    --cc=poky@yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.