diff options
| -rw-r--r-- | documentation/poky-ref-manual/development.xml | 50 | ||||
| -rw-r--r-- | documentation/poky-ref-manual/extendpoky.xml | 1 | ||||
| -rw-r--r-- | documentation/poky-ref-manual/introduction.xml | 3 | ||||
| -rw-r--r-- | documentation/poky-ref-manual/poky-ref-manual.xml | 8 | ||||
| -rw-r--r-- | documentation/poky-ref-manual/ref-bitbake.xml | 2 | ||||
| -rw-r--r-- | documentation/poky-ref-manual/ref-classes.xml | 6 | ||||
| -rw-r--r-- | documentation/poky-ref-manual/ref-images.xml | 4 | ||||
| -rw-r--r-- | documentation/poky-ref-manual/ref-structure.xml | 15 | ||||
| -rw-r--r-- | documentation/poky-ref-manual/usingpoky.xml | 5 |
9 files changed, 39 insertions, 55 deletions
diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml index a383a2f4a8..921943c155 100644 --- a/documentation/poky-ref-manual/development.xml +++ b/documentation/poky-ref-manual/development.xml | |||
| @@ -7,33 +7,37 @@ | |||
| 7 | <section id="platdev-appdev"> | 7 | <section id="platdev-appdev"> |
| 8 | <title>Software development</title> | 8 | <title>Software development</title> |
| 9 | <para> | 9 | <para> |
| 10 | Poky supports several methods of software development. These different | 10 | Poky supports several methods of software development. You can use the method that is |
| 11 | forms of development are explained below and can be switched | 11 | best for you. This chapter describes each development method. |
| 12 | between as needed. | ||
| 13 | </para> | 12 | </para> |
| 14 | 13 | ||
| 15 | <section id="platdev-appdev-external-sdk"> | 14 | <section id="platdev-appdev-external-sdk"> |
| 16 | <title>Developing externally using the Poky SDK</title> | 15 | <title>External Development Using the Poky SDK</title> |
| 17 | |||
| 18 | <para> | 16 | <para> |
| 19 | The meta-toolchain and meta-toolchain-sdk targets (<link linkend='ref-images'>see | 17 | The meta-toolchain and meta-toolchain-sdk targets (<link linkend='ref-images'>see |
| 20 | the images section</link>) build tarballs which contain toolchains and | 18 | the images section</link>) build tarballs that contain toolchains and |
| 21 | libraries suitable for application development outside Poky. These unpack into the | 19 | libraries suitable for application development outside of Poky. These tarballs |
| 20 | unpack into the | ||
| 22 | <filename class="directory">/opt/poky</filename> directory and contain | 21 | <filename class="directory">/opt/poky</filename> directory and contain |
| 23 | a setup script, e.g. | 22 | a setup script (e.g. |
| 24 | <filename>/opt/poky/environment-setup-i586-poky-linux</filename> which | 23 | <filename>/opt/poky/environment-setup-i586-poky-linux</filename>, which |
| 25 | can be sourced to initialise a suitable environment. After sourcing this, the | 24 | you can source to initialize a suitable environment. Sourcing these adds the |
| 26 | compiler, QEMU scripts, QEMU binary, a special version of pkgconfig and other | 25 | compiler, QEMU scripts, QEMU binary, a special version of pkgconfig and other |
| 27 | useful utilities are added to the PATH. Variables to assist pkgconfig and | 26 | useful utilities to the PATH variable. Variables to assist pkgconfig and |
| 28 | autotools are also set so that, for example, configure can find pre-generated test | 27 | autotools are also set so that, for example, configure can find pre-generated test |
| 29 | results for tests which need target hardware to run. | 28 | results for tests that need target hardware on which to run. |
| 30 | </para> | 29 | </para> |
| 31 | 30 | ||
| 32 | <para> | 31 | <para> |
| 33 | Using the toolchain with autotool enabled packages is straightforward, just pass the | 32 | Using the toolchain with autotool-enabled packages is straightforward - just pass the |
| 34 | appropriate host option to configure e.g. "./configure --host=arm-poky-linux-gnueabi". | 33 | appropriate host option to configure as in the following example: |
| 35 | For other projects it is usually a case of ensuring the cross tools are used e.g. | 34 | <literallayout class='monospaced'> |
| 36 | CC=arm-poky-linux-gnueabi-gcc and LD=arm-poky-linux-gnueabi-ld. | 35 | $ ./configure --host=arm-poky-linux-gnueabi |
| 36 | </literallayout> | ||
| 37 | For other projects it is usually a case of ensuring the cross tools are used: | ||
| 38 | <literallayout class='monospaced'> | ||
| 39 | CC=arm-poky-linux-gnueabi-gcc and LD=arm-poky-linux-gnueabi-ld | ||
| 40 | </literallayout> | ||
| 37 | </para> | 41 | </para> |
| 38 | </section> | 42 | </section> |
| 39 | 43 | ||
| @@ -215,7 +219,6 @@ | |||
| 215 | </section> | 219 | </section> |
| 216 | </section> | 220 | </section> |
| 217 | 221 | ||
| 218 | |||
| 219 | <section id="platdev-appdev-qemu"> | 222 | <section id="platdev-appdev-qemu"> |
| 220 | <title>Developing externally in QEMU</title> | 223 | <title>Developing externally in QEMU</title> |
| 221 | <para> | 224 | <para> |
| @@ -249,9 +252,9 @@ | |||
| 249 | also contain an NFS server exporting the guest's root filesystem | 252 | also contain an NFS server exporting the guest's root filesystem |
| 250 | allowing that to be made available to the host. | 253 | allowing that to be made available to the host. |
| 251 | </para> | 254 | </para> |
| 252 | </section> | 255 | </section> |
| 253 | 256 | ||
| 254 | <section id="platdev-appdev-insitu"> | 257 | <section id="platdev-appdev-insitu"> |
| 255 | <title>Developing in Poky directly</title> | 258 | <title>Developing in Poky directly</title> |
| 256 | <para> | 259 | <para> |
| 257 | Working directly in Poky is a fast and effective development technique. | 260 | Working directly in Poky is a fast and effective development technique. |
| @@ -296,10 +299,9 @@ $ bitbake matchbox-desktop | |||
| 296 | linkend="usingpoky-components-bitbake">2.1.1</link> and <link | 299 | linkend="usingpoky-components-bitbake">2.1.1</link> and <link |
| 297 | linkend="usingpoky-debugging-taskrunning">2.4.2</link>. | 300 | linkend="usingpoky-debugging-taskrunning">2.4.2</link>. |
| 298 | </para> | 301 | </para> |
| 302 | </section> | ||
| 299 | 303 | ||
| 300 | </section> | 304 | <section id="platdev-appdev-devshell"> |
| 301 | |||
| 302 | <section id="platdev-appdev-devshell"> | ||
| 303 | <title>Developing with 'devshell'</title> | 305 | <title>Developing with 'devshell'</title> |
| 304 | 306 | ||
| 305 | <para> | 307 | <para> |
| @@ -346,7 +348,6 @@ $ bitbake matchbox-desktop -c devshell | |||
| 346 | environmental variables such as CC to assist applications, such as make, | 348 | environmental variables such as CC to assist applications, such as make, |
| 347 | find the correct tools. | 349 | find the correct tools. |
| 348 | </para> | 350 | </para> |
| 349 | |||
| 350 | </section> | 351 | </section> |
| 351 | 352 | ||
| 352 | <section id="platdev-appdev-srcrev"> | 353 | <section id="platdev-appdev-srcrev"> |
| @@ -369,8 +370,7 @@ $ bitbake matchbox-desktop -c devshell | |||
| 369 | revision updating. | 370 | revision updating. |
| 370 | </para> | 371 | </para> |
| 371 | </section> | 372 | </section> |
| 372 | 373 | </section> | |
| 373 | </section> | ||
| 374 | 374 | ||
| 375 | <section id="platdev-gdb-remotedebug"> | 375 | <section id="platdev-gdb-remotedebug"> |
| 376 | <title>Debugging with GDB Remotely</title> | 376 | <title>Debugging with GDB Remotely</title> |
diff --git a/documentation/poky-ref-manual/extendpoky.xml b/documentation/poky-ref-manual/extendpoky.xml index 662096844d..57e085f403 100644 --- a/documentation/poky-ref-manual/extendpoky.xml +++ b/documentation/poky-ref-manual/extendpoky.xml | |||
| @@ -598,7 +598,6 @@ DISPLAY_SUBPIXEL_ORDER=vrgb | |||
| 598 | BBFILES ?= "" | 598 | BBFILES ?= "" |
| 599 | BBLAYERS = " \ | 599 | BBLAYERS = " \ |
| 600 | /path/to/poky/meta \ | 600 | /path/to/poky/meta \ |
| 601 | /path/to/poky/meta-moblin \ | ||
| 602 | /path/to/poky/meta-emenlow \ | 601 | /path/to/poky/meta-emenlow \ |
| 603 | /path/to/poky/meta-extras \ | 602 | /path/to/poky/meta-extras \ |
| 604 | " | 603 | " |
diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml index 0b407a142a..2683d01f22 100644 --- a/documentation/poky-ref-manual/introduction.xml +++ b/documentation/poky-ref-manual/introduction.xml | |||
| @@ -324,7 +324,6 @@ $ poky-qemu <kernel> <image> | |||
| 324 | <filename class="directory">/opt/poky</filename>) and then enabling the option | 324 | <filename class="directory">/opt/poky</filename>) and then enabling the option |
| 325 | in <filename>local.conf</filename>. | 325 | in <filename>local.conf</filename>. |
| 326 | </para> | 326 | </para> |
| 327 | |||
| 328 | </section> | 327 | </section> |
| 329 | 328 | ||
| 330 | <section id='intro-getit-dev'> | 329 | <section id='intro-getit-dev'> |
| @@ -343,9 +342,7 @@ $ poky-qemu <kernel> <image> | |||
| 343 | if this is undesireable we recommend using one of the release branches. | 342 | if this is undesireable we recommend using one of the release branches. |
| 344 | </para> | 343 | </para> |
| 345 | </section> | 344 | </section> |
| 346 | |||
| 347 | </section> | 345 | </section> |
| 348 | |||
| 349 | </chapter> | 346 | </chapter> |
| 350 | <!-- | 347 | <!-- |
| 351 | vim: expandtab tw=80 ts=4 | 348 | vim: expandtab tw=80 ts=4 |
diff --git a/documentation/poky-ref-manual/poky-ref-manual.xml b/documentation/poky-ref-manual/poky-ref-manual.xml index fc7ed35e13..952b5d602f 100644 --- a/documentation/poky-ref-manual/poky-ref-manual.xml +++ b/documentation/poky-ref-manual/poky-ref-manual.xml | |||
| @@ -1,7 +1,7 @@ | |||
| 1 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
| 3 | 3 | ||
| 4 | <book id='poky-handbook' lang='en' | 4 | <book id='poky-ref-manual' lang='en' |
| 5 | xmlns:xi="http://www.w3.org/2003/XInclude" | 5 | xmlns:xi="http://www.w3.org/2003/XInclude" |
| 6 | xmlns="http://docbook.org/ns/docbook" | 6 | xmlns="http://docbook.org/ns/docbook" |
| 7 | > | 7 | > |
| @@ -15,8 +15,8 @@ | |||
| 15 | </imageobject> | 15 | </imageobject> |
| 16 | </mediaobject> | 16 | </mediaobject> |
| 17 | 17 | ||
| 18 | <title>Poky Handbook</title> | 18 | <title>Poky Reference Manual</title> |
| 19 | <subtitle>Hitchhiker's Guide to Poky</subtitle> | 19 | <subtitle>A Guide and Reference to Poky</subtitle> |
| 20 | 20 | ||
| 21 | <authorgroup> | 21 | <authorgroup> |
| 22 | <author> | 22 | <author> |
| @@ -45,7 +45,7 @@ | |||
| 45 | <revhistory> | 45 | <revhistory> |
| 46 | <revision> | 46 | <revision> |
| 47 | <revnumber>3.3+git</revnumber> | 47 | <revnumber>3.3+git</revnumber> |
| 48 | <date>11 June 2010</date> | 48 | <date>20 Sept 2010</date> |
| 49 | <revremark>Poky Master Documentation</revremark> | 49 | <revremark>Poky Master Documentation</revremark> |
| 50 | </revision> | 50 | </revision> |
| 51 | </revhistory> | 51 | </revhistory> |
diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml index eaf9467950..ed6c8bc15b 100644 --- a/documentation/poky-ref-manual/ref-bitbake.xml +++ b/documentation/poky-ref-manual/ref-bitbake.xml | |||
| @@ -26,7 +26,7 @@ | |||
| 26 | <title>Parsing</title> | 26 | <title>Parsing</title> |
| 27 | 27 | ||
| 28 | <para> | 28 | <para> |
| 29 | The first thing BitBake does is that work out its configuration by | 29 | The first thing BitBake does is work out its configuration by |
| 30 | looking for a file called <filename>bitbake.conf</filename>. | 30 | looking for a file called <filename>bitbake.conf</filename>. |
| 31 | Bitbake searches through the <varname>BBPATH</varname> environment | 31 | Bitbake searches through the <varname>BBPATH</varname> environment |
| 32 | variable looking for a <filename class="directory">conf/</filename> | 32 | variable looking for a <filename class="directory">conf/</filename> |
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml index 036044dd28..38122c0301 100644 --- a/documentation/poky-ref-manual/ref-classes.xml +++ b/documentation/poky-ref-manual/ref-classes.xml | |||
| @@ -53,7 +53,7 @@ | |||
| 53 | </para> | 53 | </para> |
| 54 | 54 | ||
| 55 | <para> | 55 | <para> |
| 56 | It's useful to have some idea on how the tasks defined by this class work | 56 | It's useful to have some idea of how the tasks defined by this class work |
| 57 | and what they do behind the scenes. | 57 | and what they do behind the scenes. |
| 58 | </para> | 58 | </para> |
| 59 | 59 | ||
| @@ -355,8 +355,8 @@ | |||
| 355 | 355 | ||
| 356 | <para> | 356 | <para> |
| 357 | This class checks prerequisite software is present to | 357 | This class checks prerequisite software is present to |
| 358 | notify the users problems that will affect their build. It also | 358 | notify the users of potential problems that will affect their build. It |
| 359 | performs basic checks of the user configuration from local.conf to | 359 | also performs basic checks of the user configuration from local.conf to |
| 360 | prevent common mistakes resulting in build failures. It's usually up to | 360 | prevent common mistakes resulting in build failures. It's usually up to |
| 361 | distribution policy whether to include this class (Poky does). | 361 | distribution policy whether to include this class (Poky does). |
| 362 | </para> | 362 | </para> |
diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml index 03583eb394..79a5c1806e 100644 --- a/documentation/poky-ref-manual/ref-images.xml +++ b/documentation/poky-ref-manual/ref-images.xml | |||
| @@ -8,9 +8,9 @@ | |||
| 8 | Poky has several standard images covering most people's standard needs. A full | 8 | Poky has several standard images covering most people's standard needs. A full |
| 9 | list of image targets can be found by looking in the directories | 9 | list of image targets can be found by looking in the directories |
| 10 | <filename class="directory"> meta/recipes-core/images/</filename>, | 10 | <filename class="directory"> meta/recipes-core/images/</filename>, |
| 11 | <filename class="directory"> meta/packages/images/</filename>, | 11 | <filename class="directory"> meta/recipes-extended/images/</filename>, |
| 12 | <filename class="directory"> meta/recipes-sato/images/</filename> and | 12 | <filename class="directory"> meta/recipes-sato/images/</filename> and |
| 13 | <filename class="directory"> meta/packages/meta/</filename>. The standard | 13 | <filename class="directory"> meta/recipes-tbd/meta/</filename>. The standard |
| 14 | images are listed below along with details of what they contain: | 14 | images are listed below along with details of what they contain: |
| 15 | </para> | 15 | </para> |
| 16 | 16 | ||
diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index ca589de428..296ea54eb3 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml | |||
| @@ -7,7 +7,7 @@ | |||
| 7 | 7 | ||
| 8 | <para> | 8 | <para> |
| 9 | Poky consists of several components and understanding what these are | 9 | Poky consists of several components and understanding what these are |
| 10 | and where they're located is one of the keys to use it. This section walks | 10 | and where they're located is one of the keys to using it. This section walks |
| 11 | through the Poky directory structure giving information about the various | 11 | through the Poky directory structure giving information about the various |
| 12 | files and directories. | 12 | files and directories. |
| 13 | </para> | 13 | </para> |
| @@ -121,10 +121,10 @@ | |||
| 121 | </section> | 121 | </section> |
| 122 | 122 | ||
| 123 | <section id='handbook'> | 123 | <section id='handbook'> |
| 124 | <title><filename class="directory">handbook</filename></title> | 124 | <title><filename class="directory">documentation</filename></title> |
| 125 | 125 | ||
| 126 | <para> | 126 | <para> |
| 127 | This is the location where this handbook is generated | 127 | This is the location for documentaiton about poky including this handbook. |
| 128 | </para> | 128 | </para> |
| 129 | </section> | 129 | </section> |
| 130 | 130 | ||
| @@ -488,15 +488,6 @@ source POKY_SRC/poky-init-build-env [BUILDDIR] | |||
| 488 | </para> | 488 | </para> |
| 489 | </section> | 489 | </section> |
| 490 | 490 | ||
| 491 | <section id='structure-meta-packages'> | ||
| 492 | <title><filename class="directory">meta/packages/</filename></title> | ||
| 493 | |||
| 494 | <para> | ||
| 495 | this is a catch-all place for the rest which not fits into above | ||
| 496 | recipes-***. Images and tasks are also placed here. | ||
| 497 | </para> | ||
| 498 | </section> | ||
| 499 | |||
| 500 | <section id='structure-meta-site'> | 491 | <section id='structure-meta-site'> |
| 501 | <title><filename class="directory">meta/site/</filename></title> | 492 | <title><filename class="directory">meta/site/</filename></title> |
| 502 | 493 | ||
diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml index ad6bda2545..70fa5102f5 100644 --- a/documentation/poky-ref-manual/usingpoky.xml +++ b/documentation/poky-ref-manual/usingpoky.xml | |||
| @@ -134,7 +134,6 @@ $ source poky-init-build-env [build_dir] | |||
| 134 | <para> | 134 | <para> |
| 135 | <literallayout class='monospaced'> | 135 | <literallayout class='monospaced'> |
| 136 | $ bitbake <target> | 136 | $ bitbake <target> |
| 137 | $ bitbake qemu-native | ||
| 138 | </literallayout> | 137 | </literallayout> |
| 139 | </para> | 138 | </para> |
| 140 | <para> | 139 | <para> |
| @@ -143,8 +142,6 @@ $ bitbake qemu-native | |||
| 143 | or the name of a recipe for a specific piece of software like | 142 | or the name of a recipe for a specific piece of software like |
| 144 | <application>busybox</application>. More details about the standard images | 143 | <application>busybox</application>. More details about the standard images |
| 145 | are available in the <link linkend='ref-images'>image reference section</link>. | 144 | are available in the <link linkend='ref-images'>image reference section</link>. |
| 146 | The qemu-native target will build the poky customized qemu, and will be used | ||
| 147 | by runqemu script later. | ||
| 148 | </para> | 145 | </para> |
| 149 | </section> | 146 | </section> |
| 150 | 147 | ||
| @@ -225,7 +222,7 @@ $ bitbake qemu-native | |||
| 225 | <para> | 222 | <para> |
| 226 | You can view a list of tasks in a given package by running | 223 | You can view a list of tasks in a given package by running |
| 227 | the listtasks task e.g. <command>bitbake matchbox-desktop -c | 224 | the listtasks task e.g. <command>bitbake matchbox-desktop -c |
| 228 | listtasks</command>, and the result is in file ${WORKDIR}/temp/log.do_listtasks.pid. | 225 | listtasks</command>, and the result is in file ${WORKDIR}/temp/log.do_listtasks. |
| 229 | </para> | 226 | </para> |
| 230 | </section> | 227 | </section> |
| 231 | 228 | ||
