]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core-contrib.git/commitdiff
documentation: dev-manual - fixed capitalization on Source Directory.
authorScott Rifenbark <scott.m.rifenbark@intel.com>
Mon, 22 Oct 2012 16:59:12 +0000 (09:59 -0700)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Mon, 22 Oct 2012 23:03:13 +0000 (00:03 +0100)
(From yocto-docs rev: 8cfbd4eb519b2b966626c9a1ffd8515c198c2abd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
documentation/dev-manual/dev-manual-common-tasks.xml

index 2f73e28829b4e70314d26fa712edf0f8c4b4c7ba..20742ad5390d0929c703fa820fb411649fb27ecd 100644 (file)
             <title>Layers</title>
 
             <para>
-                The source directory contains several layers right out of the box.
-                You can easily identify a layer in the source directory by its folder name.
+                The Source Directory contains several layers right out of the box.
+                You can easily identify a layer in the Source Directory by its folder name.
                 Folders that are layers begin with the string <filename>meta</filename>.
-                For example, when you set up the <link linkend='source-directory'>source directory</link>
+                For example, when you set up the <link linkend='source-directory'>Source Directory</link>
                 structure, you will see several layers: <filename>meta</filename>, 
                 <filename>meta-hob</filename>, <filename>meta-skeleton</filename>, 
                 <filename>meta-yocto</filename>, and <filename>meta-yocto-bsp</filename>.
                         If this is the case, you need to address that deficiency instead of overlaying
                         the include file.
                         For example, consider how Qt 4 database support plug-ins are configured.
-                        The source directory does not have 
+                        The Source Directory does not have 
                         MySQL or PostgreSQL, however OpenEmbedded's
                         layer <filename>meta-oe</filename> does.
                         Consequently, <filename>meta-oe</filename> uses <filename>.bbappend</filename>
                         files to modify the <filename>QT_SQL_DRIVER_FLAGS</filename> variable to enable 
                         the appropriate plugins. 
                         This variable was added to the <filename>qt4.inc</filename> include file in 
-                        the source directory specifically to allow the <filename>meta-oe</filename> layer
+                        the Source Directory specifically to allow the <filename>meta-oe</filename> layer
                         to be able to control which plugins are built.</para></listitem>
                 </itemizedlist> 
             </para>
                         <filename>meta-&lt;layer_name&gt;</filename> format.</para></listitem>
                     <listitem><para>Clone the repository alongside other <filename>meta</filename>
                         directories in the 
-                        <link linkend='source-directory'>source directory</link>.</para></listitem>
+                        <link linkend='source-directory'>Source Directory</link>.</para></listitem>
                  </itemizedlist>
-                 Following these recommendations keeps your source directory and 
+                 Following these recommendations keeps your Source Directory and 
                  its configuration entirely inside the Yocto Project's core base.
             </para>
         </section>
             <para>
                 As an example, consider the main formfactor recipe and a corresponding formfactor 
                 append file both from the 
-                <link linkend='source-directory'>source directory</link>.
+                <link linkend='source-directory'>Source Directory</link>.
                 Here is the main formfactor recipe, which is named <filename>formfactor_0.0.bb</filename> and  
                 located in the meta layer at <filename>meta/recipes-bsp/formfactor</filename>:
                 <literallayout class='monospaced'>
                 with specialized image <filename>.bb</filename> files.
                 You can also add more features by configuring the 
                 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</ulink></filename>
-                variable in the <filename>local.conf</filename> file found in the source directory
+                variable in the <filename>local.conf</filename> file found in the Source Directory
                 located in the build directory.
             </para>
 
                 You need to either create a new kernel recipe for this machine, or extend an 
                 existing recipe. 
                 You can find several kernel examples in the 
-                source directory at <filename>meta/recipes-kernel/linux</filename>
+                Source Directory at <filename>meta/recipes-kernel/linux</filename>
                 that you can use as references.
             </para>
 
                 extended to support multiple libraries. 
                 Many standard recipes are already extended and support multiple libraries.
                 You can check in the <filename>meta/conf/multilib.conf</filename>
-                configuration file in the source directory to see how this is 
+                configuration file in the Source Directory to see how this is 
                 done using the 
                 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></ulink>
                 variable.
                 script found in the 
                 <link linkend='build-directory'>Build Directory</link>.
                 The following commands build and invoke <filename>menuconfig</filename> assuming the 
-                source directory top-level folder is <filename>~/poky</filename>:
+                Source Directory top-level folder is <filename>~/poky</filename>:
                 <literallayout class='monospaced'>
      $ cd ~/poky
      $ source oe-init-build-env
      $ bitbake world -f -c distro_check
             </literallayout>
             The results are stored in the <filename>build/tmp/log/distro_check-${DATETIME}.results</filename> 
-            file found in the source directory.
+            file found in the Source Directory.
         </para>
     </section>
 
 
         <para>
             Situations exist where you might want to build software from source files that are external to 
-            and thus outside of the <link linkend='source-directory'>source directory</link>.
+            and thus outside of the <link linkend='source-directory'>Source Directory</link>.
             For example, suppose you have a project that includes a new BSP with a heavily customized 
             kernel, a very minimal image, and some new user-space recipes.
             And, you want to minimize exposing the build system to the