documentation: Config fragment sections updated

I have updated both the section for configuration fragments found
in the BSP and dev manuals.

Reported-by: James Abernathy <jabernathy@gmail.com>
(From yocto-docs rev: 62f4df751c80e7b749356bb80ade3a7847411f7c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 0159f4884842a3e8cb1456c32b037fa57f1466ff..05094ca77d891096b7098aed252bb3a66bccf5c6 100644 (file)
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -596,22 +596,22 @@
             </para>
 
             <para>
-                For example, suppose you had a set of configuration options in a file called 
-                <filename>myconfig.cfg</filename>.  
-                If you put that file inside a directory named <filename>/linux-yocto</filename> and then added 
-                a <filename>SRC_URI</filename> statement such as the following to the append file, 
-                those configuration options will be picked up and applied when the kernel is built.
+                For example, suppose you had a some configuration options in a file called 
+                <filename>network_configs.cfg</filename>.  
+                You can place that file inside a directory named <filename>/linux-yocto</filename> and then add 
+                a <filename>SRC_URI</filename> statement such as the following to the append file.
+                When the OpenEmbedded build system builds the kernel, the configuration options are 
+                picked up and applied.
                 <literallayout class='monospaced'>
-     SRC_URI += "file://myconfig.cfg"
+     SRC_URI += "file://network_configs.cfg"
                 </literallayout>
             </para>
 
             <para>
-                As mentioned earlier, you can group related configurations into multiple files and 
-                name them all in the <filename>SRC_URI</filename> statement as well.
-                For example, you could group separate configurations specifically for Ethernet and graphics
-                into their own files and add those by using a <filename>SRC_URI</filename> statement like the 
-                following in your append file:
+                To group related configurations into multiple files, you perform a similar procedure. 
+                Here is an example that groups separate configurations specifically for Ethernet and graphics
+                into their own files and adds the configurations
+                by using a <filename>SRC_URI</filename> statement like the following in your append file:
                 <literallayout class='monospaced'>
      SRC_URI += "file://myconfig.cfg \
             file://eth.cfg \

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index d96d78d49e36b3d97b881c6f68bb971d0ac8dd2f..b8708ff19f2b22d81d8f9b92cfc364ae93e7ba2c 100644 (file)
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1362,18 +1362,29 @@
         </section>
 
         <section id='creating-config-fragments'>
-            <title>Creating Config Fragments</title>
+            <title>Creating Configuration Fragments</title>
 
             <para>
-                Configuration fragments are simply kernel options that appear in a file.
+                Configuration fragments are simply kernel options that appear in a file
+                placed where the OpenEmbedded build system can find and apply them.
                 Syntactically, the configuration statement is identical to what would appear
-                in the <filename>.config</filename>.
-                For example, issuing the following from the shell would create a config fragment
+                in the <filename>.config</filename> file, which is in the 
+                <link linkend='build-directory'>build directory</link> in 
+                <filename>tmp/work/&lt;arch&gt;-poky-linux/linux-yocto-&lt;release-specific-string&gt;/linux-&lt;arch&gt;-&lt;build-type&gt;</filename>.
+            </para>
+
+            <para>
+                It is simple to create a configuration fragment.  
+                For example, issuing the following from the shell creates a configuration fragment
                 file named <filename>my_smp.cfg</filename> that enables multi-processor support
                 within the kernel:
                 <literallayout class='monospaced'>
      $ echo "CONFIG_SMP=y" >> my_smp.cfg
                 </literallayout>
+                <note>
+                    All configuration files must use the <filename>.cfg</filename> extension in order
+                    for the OpenEmbedded build system to recognize them as a configuration fragment.
+                </note>
             </para>
 
             <para>
@@ -1382,15 +1393,28 @@
                 <filename>SRC_URI</filename>.
                 The OpenEmbedded build system will pick up the configuration and add it to the 
                 kernel's configuration.
-                For example, assume you add the following to your 
-                <filename>linux-yocto_3.0.bbappend</filename> file:
+                For example, suppose you had a set of configuration options in a file called 
+                <filename>myconfig.cfg</filename>.  
+                If you put that file inside a directory named <filename>/linux-yocto</filename> 
+                that resides in the same directory as the kernel's append file and then add 
+                a <filename>SRC_URI</filename> statement such as the following to the kernel's append file, 
+                those configuration options will be picked up and applied when the kernel is built.
+                <literallayout class='monospaced'>
+     SRC_URI += "file://myconfig.cfg"
+                </literallayout>
+            </para>
+
+            <para>
+                As mentioned earlier, you can group related configurations into multiple files and 
+                name them all in the <filename>SRC_URI</filename> statement as well.
+                For example, you could group separate configurations specifically for Ethernet and graphics
+                into their own files and add those by using a <filename>SRC_URI</filename> statement like the 
+                following in your append file:
                 <literallayout class='monospaced'>
-     file://my_smp.cfg
+     SRC_URI += "file://myconfig.cfg \
+            file://eth.cfg \
+            file://gfx.cfg"
                 </literallayout>
-                You would put the config fragment file <filename>my_smp.cfg</filename> in a 
-                sub-directory with the same root name (<filename>linux-yocto</filename>)
-                beneath the directory that contains your <filename>linux-yocto_3.0.bbappend</filename> 
-                file and the build system will pick up and apply the fragment.
             </para>
         </section>