documentation/poky-ref-manual: Various tweaks to the text
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
This commit is contained in:
parent
0be66f0e88
commit
80eba26fb1
|
@ -7,33 +7,37 @@
|
||||||
<section id="platdev-appdev">
|
<section id="platdev-appdev">
|
||||||
<title>Software development</title>
|
<title>Software development</title>
|
||||||
<para>
|
<para>
|
||||||
Poky supports several methods of software development. These different
|
Poky supports several methods of software development. You can use the method that is
|
||||||
forms of development are explained below and can be switched
|
best for you. This chapter describes each development method.
|
||||||
between as needed.
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<section id="platdev-appdev-external-sdk">
|
<section id="platdev-appdev-external-sdk">
|
||||||
<title>Developing externally using the Poky SDK</title>
|
<title>External Development Using the Poky SDK</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The meta-toolchain and meta-toolchain-sdk targets (<link linkend='ref-images'>see
|
The meta-toolchain and meta-toolchain-sdk targets (<link linkend='ref-images'>see
|
||||||
the images section</link>) build tarballs which contain toolchains and
|
the images section</link>) build tarballs that contain toolchains and
|
||||||
libraries suitable for application development outside Poky. These unpack into the
|
libraries suitable for application development outside of Poky. These tarballs
|
||||||
|
unpack into the
|
||||||
<filename class="directory">/opt/poky</filename> directory and contain
|
<filename class="directory">/opt/poky</filename> directory and contain
|
||||||
a setup script, e.g.
|
a setup script (e.g.
|
||||||
<filename>/opt/poky/environment-setup-i586-poky-linux</filename> which
|
<filename>/opt/poky/environment-setup-i586-poky-linux</filename>, which
|
||||||
can be sourced to initialise a suitable environment. After sourcing this, the
|
you can source to initialize a suitable environment. Sourcing these adds the
|
||||||
compiler, QEMU scripts, QEMU binary, a special version of pkgconfig and other
|
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
|
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>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Using the toolchain with autotool enabled packages is straightforward, just pass the
|
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".
|
appropriate host option to configure as in the following example:
|
||||||
For other projects it is usually a case of ensuring the cross tools are used e.g.
|
<literallayout class='monospaced'>
|
||||||
CC=arm-poky-linux-gnueabi-gcc and LD=arm-poky-linux-gnueabi-ld.
|
$ ./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>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
@ -215,7 +219,6 @@
|
||||||
</section>
|
</section>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|
||||||
<section id="platdev-appdev-qemu">
|
<section id="platdev-appdev-qemu">
|
||||||
<title>Developing externally in QEMU</title>
|
<title>Developing externally in QEMU</title>
|
||||||
<para>
|
<para>
|
||||||
|
@ -249,9 +252,9 @@
|
||||||
also contain an NFS server exporting the guest's root filesystem
|
also contain an NFS server exporting the guest's root filesystem
|
||||||
allowing that to be made available to the host.
|
allowing that to be made available to the host.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id="platdev-appdev-insitu">
|
<section id="platdev-appdev-insitu">
|
||||||
<title>Developing in Poky directly</title>
|
<title>Developing in Poky directly</title>
|
||||||
<para>
|
<para>
|
||||||
Working directly in Poky is a fast and effective development technique.
|
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-components-bitbake">2.1.1</link> and <link
|
||||||
linkend="usingpoky-debugging-taskrunning">2.4.2</link>.
|
linkend="usingpoky-debugging-taskrunning">2.4.2</link>.
|
||||||
</para>
|
</para>
|
||||||
|
</section>
|
||||||
|
|
||||||
</section>
|
<section id="platdev-appdev-devshell">
|
||||||
|
|
||||||
<section id="platdev-appdev-devshell">
|
|
||||||
<title>Developing with 'devshell'</title>
|
<title>Developing with 'devshell'</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
@ -346,7 +348,6 @@ $ bitbake matchbox-desktop -c devshell
|
||||||
environmental variables such as CC to assist applications, such as make,
|
environmental variables such as CC to assist applications, such as make,
|
||||||
find the correct tools.
|
find the correct tools.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id="platdev-appdev-srcrev">
|
<section id="platdev-appdev-srcrev">
|
||||||
|
@ -369,8 +370,7 @@ $ bitbake matchbox-desktop -c devshell
|
||||||
revision updating.
|
revision updating.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
</section>
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="platdev-gdb-remotedebug">
|
<section id="platdev-gdb-remotedebug">
|
||||||
<title>Debugging with GDB Remotely</title>
|
<title>Debugging with GDB Remotely</title>
|
||||||
|
|
|
@ -598,7 +598,6 @@ DISPLAY_SUBPIXEL_ORDER=vrgb
|
||||||
BBFILES ?= ""
|
BBFILES ?= ""
|
||||||
BBLAYERS = " \
|
BBLAYERS = " \
|
||||||
/path/to/poky/meta \
|
/path/to/poky/meta \
|
||||||
/path/to/poky/meta-moblin \
|
|
||||||
/path/to/poky/meta-emenlow \
|
/path/to/poky/meta-emenlow \
|
||||||
/path/to/poky/meta-extras \
|
/path/to/poky/meta-extras \
|
||||||
"
|
"
|
||||||
|
|
|
@ -324,7 +324,6 @@ $ poky-qemu <kernel> <image>
|
||||||
<filename class="directory">/opt/poky</filename>) and then enabling the option
|
<filename class="directory">/opt/poky</filename>) and then enabling the option
|
||||||
in <filename>local.conf</filename>.
|
in <filename>local.conf</filename>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id='intro-getit-dev'>
|
<section id='intro-getit-dev'>
|
||||||
|
@ -343,9 +342,7 @@ $ poky-qemu <kernel> <image>
|
||||||
if this is undesireable we recommend using one of the release branches.
|
if this is undesireable we recommend using one of the release branches.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
</chapter>
|
</chapter>
|
||||||
<!--
|
<!--
|
||||||
vim: expandtab tw=80 ts=4
|
vim: expandtab tw=80 ts=4
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
"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:xi="http://www.w3.org/2003/XInclude"
|
||||||
xmlns="http://docbook.org/ns/docbook"
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
>
|
>
|
||||||
|
@ -15,8 +15,8 @@
|
||||||
</imageobject>
|
</imageobject>
|
||||||
</mediaobject>
|
</mediaobject>
|
||||||
|
|
||||||
<title>Poky Handbook</title>
|
<title>Poky Reference Manual</title>
|
||||||
<subtitle>Hitchhiker's Guide to Poky</subtitle>
|
<subtitle>A Guide and Reference to Poky</subtitle>
|
||||||
|
|
||||||
<authorgroup>
|
<authorgroup>
|
||||||
<author>
|
<author>
|
||||||
|
@ -45,7 +45,7 @@
|
||||||
<revhistory>
|
<revhistory>
|
||||||
<revision>
|
<revision>
|
||||||
<revnumber>3.3+git</revnumber>
|
<revnumber>3.3+git</revnumber>
|
||||||
<date>11 June 2010</date>
|
<date>20 Sept 2010</date>
|
||||||
<revremark>Poky Master Documentation</revremark>
|
<revremark>Poky Master Documentation</revremark>
|
||||||
</revision>
|
</revision>
|
||||||
</revhistory>
|
</revhistory>
|
||||||
|
|
|
@ -26,7 +26,7 @@
|
||||||
<title>Parsing</title>
|
<title>Parsing</title>
|
||||||
|
|
||||||
<para>
|
<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>.
|
looking for a file called <filename>bitbake.conf</filename>.
|
||||||
Bitbake searches through the <varname>BBPATH</varname> environment
|
Bitbake searches through the <varname>BBPATH</varname> environment
|
||||||
variable looking for a <filename class="directory">conf/</filename>
|
variable looking for a <filename class="directory">conf/</filename>
|
||||||
|
|
|
@ -53,7 +53,7 @@
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<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.
|
and what they do behind the scenes.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
@ -355,8 +355,8 @@
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
This class checks prerequisite software is present to
|
This class checks prerequisite software is present to
|
||||||
notify the users problems that will affect their build. It also
|
notify the users of potential problems that will affect their build. It
|
||||||
performs basic checks of the user configuration from local.conf to
|
also performs basic checks of the user configuration from local.conf to
|
||||||
prevent common mistakes resulting in build failures. It's usually up to
|
prevent common mistakes resulting in build failures. It's usually up to
|
||||||
distribution policy whether to include this class (Poky does).
|
distribution policy whether to include this class (Poky does).
|
||||||
</para>
|
</para>
|
||||||
|
|
|
@ -8,9 +8,9 @@
|
||||||
Poky has several standard images covering most people's standard needs. A full
|
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
|
list of image targets can be found by looking in the directories
|
||||||
<filename class="directory"> meta/recipes-core/images/</filename>,
|
<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/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:
|
images are listed below along with details of what they contain:
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Poky consists of several components and understanding what these are
|
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
|
through the Poky directory structure giving information about the various
|
||||||
files and directories.
|
files and directories.
|
||||||
</para>
|
</para>
|
||||||
|
@ -121,10 +121,10 @@
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id='handbook'>
|
<section id='handbook'>
|
||||||
<title><filename class="directory">handbook</filename></title>
|
<title><filename class="directory">documentation</filename></title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
This is the location where this handbook is generated
|
This is the location for documentaiton about poky including this handbook.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
@ -488,15 +488,6 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</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'>
|
<section id='structure-meta-site'>
|
||||||
<title><filename class="directory">meta/site/</filename></title>
|
<title><filename class="directory">meta/site/</filename></title>
|
||||||
|
|
||||||
|
|
|
@ -134,7 +134,6 @@ $ source poky-init-build-env [build_dir]
|
||||||
<para>
|
<para>
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
$ bitbake <target>
|
$ bitbake <target>
|
||||||
$ bitbake qemu-native
|
|
||||||
</literallayout>
|
</literallayout>
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
|
@ -143,8 +142,6 @@ $ bitbake qemu-native
|
||||||
or the name of a recipe for a specific piece of software like
|
or the name of a recipe for a specific piece of software like
|
||||||
<application>busybox</application>. More details about the standard images
|
<application>busybox</application>. More details about the standard images
|
||||||
are available in the <link linkend='ref-images'>image reference section</link>.
|
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>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
@ -225,7 +222,7 @@ $ bitbake qemu-native
|
||||||
<para>
|
<para>
|
||||||
You can view a list of tasks in a given package by running
|
You can view a list of tasks in a given package by running
|
||||||
the listtasks task e.g. <command>bitbake matchbox-desktop -c
|
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>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue