]> code.ossystems Code Review - openembedded-core.git/commitdiff
documentation/poky-ref-manual: Various tweaks to the text
authorRichard Purdie <rpurdie@linux.intel.com>
Fri, 15 Oct 2010 14:06:33 +0000 (15:06 +0100)
committerRichard Purdie <rpurdie@linux.intel.com>
Fri, 15 Oct 2010 14:07:06 +0000 (15:07 +0100)
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
documentation/poky-ref-manual/development.xml
documentation/poky-ref-manual/extendpoky.xml
documentation/poky-ref-manual/introduction.xml
documentation/poky-ref-manual/poky-ref-manual.xml
documentation/poky-ref-manual/ref-bitbake.xml
documentation/poky-ref-manual/ref-classes.xml
documentation/poky-ref-manual/ref-images.xml
documentation/poky-ref-manual/ref-structure.xml
documentation/poky-ref-manual/usingpoky.xml

index a383a2f4a8cea6ce9b6f87124533c953f8c814e0..921943c15513ef8aef9506f532860a9de91959df 100644 (file)
@@ -7,33 +7,37 @@
 <section id="platdev-appdev">
     <title>Software development</title>
     <para>
-        Poky supports several methods of software development. These different
-        forms of development are explained below and can be switched
-        between as needed.
+        Poky supports several methods of software development. You can use the method that is 
+        best for you.  This chapter describes each development method.
     </para>
 
     <section id="platdev-appdev-external-sdk">
-        <title>Developing externally using the Poky SDK</title>
-
+        <title>External Development Using the Poky SDK</title>
         <para>
             The meta-toolchain and meta-toolchain-sdk targets (<link linkend='ref-images'>see
-            the images section</link>) build tarballs which contain toolchains and 
-            libraries suitable for application development outside Poky. These unpack into the 
+            the images section</link>) build tarballs that contain toolchains and 
+            libraries suitable for application development outside of Poky. These tarballs 
+            unpack into the 
             <filename class="directory">/opt/poky</filename> directory and contain
-            a setup scripte.g. 
-            <filename>/opt/poky/environment-setup-i586-poky-linux</filename> which
-            can be sourced to initialise a suitable environment. After sourcing this, the 
+            a setup script (e.g. 
+            <filename>/opt/poky/environment-setup-i586-poky-linux</filename>, which
+            you can source to initialize a suitable environment. Sourcing these adds the 
             compiler, QEMU scripts, QEMU binary, a special version of pkgconfig and other 
-            useful utilities are added to the PATH. Variables to assist pkgconfig and 
+            useful utilities to the PATH variable. Variables to assist pkgconfig and 
             autotools are also set so that, for example, configure can find pre-generated test 
-            results for tests which need target hardware to run.
+            results for tests that need target hardware on which to run.
         </para>
 
         <para>
-            Using the toolchain with autotool enabled packages is straightforward, just pass the 
-            appropriate host option to configure e.g. "./configure --host=arm-poky-linux-gnueabi".
-            For other projects it is usually a case of ensuring the cross tools are used e.g.
-            CC=arm-poky-linux-gnueabi-gcc and LD=arm-poky-linux-gnueabi-ld.
+            Using the toolchain with autotool-enabled packages is straightforward - just pass the 
+            appropriate host option to configure as in the following example:
+            <literallayout class='monospaced'>
+     $ ./configure --host=arm-poky-linux-gnueabi
+            </literallayout>
+            For other projects it is usually a case of ensuring the cross tools are used:
+            <literallayout class='monospaced'>
+     CC=arm-poky-linux-gnueabi-gcc and LD=arm-poky-linux-gnueabi-ld
+            </literallayout>
         </para>
     </section>
 
         </section>
     </section>
 
-
     <section id="platdev-appdev-qemu">
         <title>Developing externally in QEMU</title>
         <para>
             also contain an NFS server exporting the guest's root filesystem 
             allowing that to be made available to the host.
         </para>
-    </section>              
+        </section>              
 
-    <section id="platdev-appdev-insitu">
+        <section id="platdev-appdev-insitu">
         <title>Developing in Poky directly</title>
         <para>
             Working directly in Poky is a fast and effective development technique.
@@ -296,10 +299,9 @@ $ bitbake matchbox-desktop
             linkend="usingpoky-components-bitbake">2.1.1</link> and <link 
             linkend="usingpoky-debugging-taskrunning">2.4.2</link>.
         </para>
+        </section>
 
-    </section>
-
-    <section id="platdev-appdev-devshell">
+        <section id="platdev-appdev-devshell">
         <title>Developing with 'devshell'</title>
 
         <para>
@@ -346,7 +348,6 @@ $ bitbake matchbox-desktop -c devshell
             environmental variables such as CC to assist applications, such as make,
             find the correct tools.
         </para>
-
     </section>
 
     <section id="platdev-appdev-srcrev">
@@ -369,8 +370,7 @@ $ bitbake matchbox-desktop -c devshell
             revision updating.
         </para>
     </section>
-
-  </section>
+</section>
 
 <section id="platdev-gdb-remotedebug">
     <title>Debugging with GDB Remotely</title>
index 662096844d090033e127e89318c3f03cfc6dda50..57e085f403a0fae0c148422e50e1520cb9391548 100644 (file)
@@ -598,7 +598,6 @@ DISPLAY_SUBPIXEL_ORDER=vrgb
 BBFILES ?= ""
 BBLAYERS = " \
   /path/to/poky/meta \
-  /path/to/poky/meta-moblin \
   /path/to/poky/meta-emenlow \
   /path/to/poky/meta-extras \
   "
index 0b407a142aeb710bf8c93bcb0d136aa3e0671aa6..2683d01f22b63e0cc57274aae7a575965ff059c6 100644 (file)
@@ -324,7 +324,6 @@ $ poky-qemu &lt;kernel&gt; &lt;image&gt;
             <filename class="directory">/opt/poky</filename>) and then enabling the option 
             in <filename>local.conf</filename>.
         </para>
-
     </section>
 
     <section id='intro-getit-dev'>
@@ -343,9 +342,7 @@ $ poky-qemu &lt;kernel&gt; &lt;image&gt;
            if this is undesireable we recommend using one of the release branches.
         </para>
     </section>
-
 </section>
-
 </chapter>
 <!--
 vim: expandtab tw=80 ts=4
index fc7ed35e1342180b5cd2b1d2a38e61009eb302b2..952b5d602f55bb8be2908a92f7a740dc80d1c78e 100644 (file)
@@ -1,7 +1,7 @@
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
-<book id='poky-handbook' lang='en' 
+<book id='poky-ref-manual' lang='en' 
       xmlns:xi="http://www.w3.org/2003/XInclude"
       xmlns="http://docbook.org/ns/docbook"
       >
@@ -15,8 +15,8 @@
             </imageobject>    
         </mediaobject>
 
-        <title>Poky Handbook</title>
-        <subtitle>Hitchhiker's Guide to Poky</subtitle>
+        <title>Poky Reference Manual</title>
+        <subtitle>A Guide and Reference to Poky</subtitle>
 
         <authorgroup>
             <author>
@@ -45,7 +45,7 @@
         <revhistory>
             <revision>
                 <revnumber>3.3+git</revnumber>
-                <date>11 June 2010</date>
+                <date>20 Sept 2010</date>
                 <revremark>Poky Master Documentation</revremark>
             </revision>
         </revhistory>
index eaf9467950a66777a6ff474258f33991c254c0df..ed6c8bc15b41d24c05e8f7906680d4bd95c0a75d 100644 (file)
@@ -26,7 +26,7 @@
         <title>Parsing</title>
 
         <para>
-            The first thing BitBake does is that work out its configuration by 
+            The first thing BitBake does is work out its configuration by 
             looking for a file called <filename>bitbake.conf</filename>.
             Bitbake searches through the <varname>BBPATH</varname> environment 
             variable looking for a <filename class="directory">conf/</filename> 
index 036044dd28ea50df5203c63241ad5328cffde327..38122c030185b8deff0b3a8da3dc839b776806cc 100644 (file)
@@ -53,7 +53,7 @@
     </para>
 
     <para>
-        It's useful to have some idea on how the tasks defined by this class work
+        It's useful to have some idea of how the tasks defined by this class work
         and what they do behind the scenes.
     </para>
 
 
     <para>
         This class checks prerequisite software is present to
-        notify the users problems that will affect their build. It also
-        performs basic checks of the user configuration from local.conf to
+        notify the users of potential problems that will affect their build. It
+        also performs basic checks of the user configuration from local.conf to
         prevent common mistakes resulting in build failures. It's usually up to
         distribution policy whether to include this class (Poky does).
     </para>
index 03583eb394794cd075d75cfcd3c0bafea039c899..79a5c1806e43ce64942211f4788c3d4cab2260c1 100644 (file)
@@ -8,9 +8,9 @@
         Poky has several standard images covering most people's standard needs. A full 
         list of image targets can be found by looking in the directories 
         <filename class="directory">  meta/recipes-core/images/</filename>, 
-        <filename class="directory">  meta/packages/images/</filename>, 
+        <filename class="directory">  meta/recipes-extended/images/</filename>, 
         <filename class="directory">  meta/recipes-sato/images/</filename> and 
-        <filename class="directory">  meta/packages/meta/</filename>. The standard 
+        <filename class="directory">  meta/recipes-tbd/meta/</filename>. The standard 
         images are listed below along with details of what they contain:
     </para>
 
index ca589de428b2c4c6d9065a35d9a4953d572aa6ac..296ea54eb3246153b32cdc8e2435ef8e11cb1e36 100644 (file)
@@ -7,7 +7,7 @@
 
 <para>
     Poky consists of several components and understanding what these are 
-    and where they're located is one of the keys to use it. This section walks 
+    and where they're located is one of the keys to using it. This section walks 
     through the Poky directory structure giving information about the various 
     files and directories.
 </para>
     </section>
 
     <section id='handbook'>
-        <title><filename class="directory">handbook</filename></title>
+        <title><filename class="directory">documentation</filename></title>
 
         <para>
-            This is the location where this handbook is generated
+            This is the location for documentaiton about poky including this handbook.
         </para>
     </section>
 
@@ -488,15 +488,6 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
         </para>
     </section>
 
-    <section id='structure-meta-packages'>
-        <title><filename class="directory">meta/packages/</filename></title>
-
-        <para>
-            this is a catch-all place for the rest which not fits into above
-            recipes-***. Images and tasks are also placed here.
-        </para>
-    </section>
-
     <section id='structure-meta-site'>
         <title><filename class="directory">meta/site/</filename></title>
 
index ad6bda25459bfd3d2148e8814d2907cadb9de39c..70fa5102f599e81e7169d0d10420713494f1dc84 100644 (file)
@@ -134,7 +134,6 @@ $ source poky-init-build-env [build_dir]
     <para>
         <literallayout class='monospaced'>
 $ bitbake &lt;target&gt;
-$ bitbake qemu-native
 </literallayout>
     </para>
     <para>
@@ -143,8 +142,6 @@ $ bitbake qemu-native
         or the name of a recipe for a specific piece of software like 
         <application>busybox</application>. More details about the standard images 
         are available in the <link linkend='ref-images'>image reference section</link>.
-        The qemu-native target will build the poky customized qemu, and will be used
-        by runqemu script later.
     </para>
 </section>
 
@@ -225,7 +222,7 @@ $ bitbake qemu-native
         <para>
             You can view a list of tasks in a given package by running
             the listtasks task e.g. <command>bitbake matchbox-desktop -c
-            listtasks</command>, and the result is in file ${WORKDIR}/temp/log.do_listtasks.pid.
+            listtasks</command>, and the result is in file ${WORKDIR}/temp/log.do_listtasks.
         </para>
     </section>