All of lore.kernel.org
 help / color / mirror / Atom feed
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
To: poky@yoctoproject.org
Subject: [PATCH 24/29] documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section.
Date: Fri, 17 Dec 2010 08:30:35 -0800	[thread overview]
Message-ID: <4d71691466079246ba74789a2202679d0784f2e0.1292876262.git.scott.m.rifenbark@intel.com> (raw)
In-Reply-To: <cover.1292876262.git.scott.m.rifenbark@intel.com>

I have re-written this section extensively based on a phone call with
Tom Z.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
---
 documentation/bsp-guide/bsp.xml |   69 ++++++++++++++++++++++----------------
 1 files changed, 40 insertions(+), 29 deletions(-)

diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 94dd516..cf9c91f 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -319,46 +319,57 @@ meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
             </programlisting>
 
             <para>
-                These files make up the definition of a kernel to use with this hardware. 
-                In this case, it is a complete self-contained kernel with its own
-                configuration and patches.
-                However, kernels can be shared between many machines as well.
-                Following is an example:
-               <programlisting>
-meta-emenlow/recipes-kernel/linux/linux-bsp_2.6.50.bb
-               </programlisting>
-                This example file is the core kernel recipe that details from where to get the kernel
-                source.
-                All standard source code locations are supported.
-                Consequently, the source could be a release tarball, a git repository, or source included in
-                the directory within the BSP itself.
-            </para>
-            <para>
-                The file then contains information about what patches to apply and how to configure and build them.
-                Because the file can reuse the main Poky kernel build class, the definitions here can 
-                remain very simple.   
+                This file appends your specific changes to the kernel you are using.
             </para>
             <para>
-                <programlisting>
-linux-bsp-2.6.50/*.patch
-                </programlisting>
+                For your BSP you typically want to use an existing Poky kernel found in the 
+                Poky repository at <filename class='directory'>meta/recipes-kernel/kernel</filename>.
+                You can append your specific changes to the kernel by using a 
+                <filename>.bbappend</filename> file, which is located in the 
+                <filename class='directory'>meta-&lt;bsp_name&gt;/recipes-kernel/linux</filename>
+                directory.
             </para>
             <para>
-                The above example file contains patches you can apply against the base kernel, from wherever
-                they may have been obtained.
+                Consider a BSP that uses the <filename>linux-yocto-stable_git.bb</filename> kernel.
+                You would use the <filename>linux-yocto-stable_git.bbappend</filename> file to add 
+                specific BSP settings to the kernel, thus configuring the kernel for your particular BSP.
             </para>
             <para>
+                Consider an example for the existing "crownbay" BSP.
+                The <filename>.bbaappend</filename> file used for the "crownbay" BSP is:
+                <programlisting>
+meta-crownbay/recipes-kernel/linux/linux-wrs_git.bbappend
+                </programlisting>
+                The file contains the following:
                 <programlisting>
-meta-emenlow/recipes-kernel/linux/linux-bsp-2.6.50/defconfig-bsp
+FILESEXTRAPATHS := "${THISDIR}/${PN}"
+COMPATIBLE_MACHINE_crownbay = "cronwbay"
+KMACHINE_crownbay = "crownbay"
                 </programlisting>
+                This <filename>.bbappend</filename> file adds "crownbay" as a compatible machine,
+                and additionally sets a Yocto Kernel-specific variable that identifies the name of the 
+                BSP branch to use in the GIT repository to find configuration information.
             </para>
-            <para>
-                Finally, this last example file contains kernel configuration information.
+            <note><para>
+                For an established BSP the configuration information is incorporated directly into the 
+                git tree.
+                For a new BSP, however, the <filename>.bbappend</filename> file needs to 
+                include its own set of configuration options in a file called 
+                <filename>defconfig</filename> located in a directory that matches the recipe name.
+                <programlisting>
+SRC_URI += "file://defconfig"
+                </programlisting>
+                Once a BSP is committed, the Yocto kernel maintainer moves this configuration information
+                into the git tree so that the <filename>.bbappend</filename> file does not need to locate
+                its own configuration options.
+                Again, the initial configuration options using the SRC_URI are put into a 
+                directory named 
+                <filename class='directory'>meta-&lt;bsp_name&gt;/recipes/linux/linux-yocto-stable</filename>.
             </para>
             <para>
-                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>
+                 You can find more information about creating a BSP that is based on an existing similar
+                 BSP by reading the "Yocto Project Kernel Architecture and Use Manual."
+            </para></note>
             </section>
 
 <!--            <section id='bsp-filelayout-packages'>
-- 
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 ` [PATCH 20/29] documentation/bsp-guide/bsp.xml: Changed numbering scheme Scott Rifenbark
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 ` Scott Rifenbark [this message]
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=4d71691466079246ba74789a2202679d0784f2e0.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.