summaryrefslogtreecommitdiff
path: root/handbook
diff options
context:
space:
mode:
authorQing He <qing.he@intel.com>2010-09-09 16:28:47 +0800
committerRichard Purdie <rpurdie@linux.intel.com>2010-09-10 12:14:02 +0100
commita6e76529448d5b5c70988fcfe3b9f4beb022b784 (patch)
treec15065b21e43f6ad9e064f37316427c4d32f9b10 /handbook
parent3c6e1d7c623672f6424508fd0ebbe795265a0fe0 (diff)
downloadopenembedded-core-a6e76529448d5b5c70988fcfe3b9f4beb022b784.tar.gz
openembedded-core-a6e76529448d5b5c70988fcfe3b9f4beb022b784.tar.bz2
openembedded-core-a6e76529448d5b5c70988fcfe3b9f4beb022b784.tar.xz
openembedded-core-a6e76529448d5b5c70988fcfe3b9f4beb022b784.zip
handbook: update appendix C/H/I
The following is suggested but not changed: - adding documentation of cmake.bbclass - remove src_distribute_local.bbclass Signed-off-by: Qing He <qing.he@intel.com> Signed-off-by: Dongxiao Xu <dongxiao.xu@intel.com>
Diffstat (limited to 'handbook')
-rw-r--r--handbook/faq.xml6
-rw-r--r--handbook/ref-classes.xml62
-rw-r--r--handbook/resources.xml10
3 files changed, 36 insertions, 42 deletions
diff --git a/handbook/faq.xml b/handbook/faq.xml
index 150ed58dd..b209fff81 100644
--- a/handbook/faq.xml
+++ b/handbook/faq.xml
@@ -43,7 +43,7 @@
</listitem>
<listitem>
<para>
- We have a Buildbot which provides continuous build and integration tests
+ We have an autobuilder which provides continuous build and integration tests
</para>
</listitem>
</itemizedlist>
@@ -207,7 +207,7 @@
<qandaentry>
<question>
<para>
- I see lots of 404 responses for files on http://folks.o-hand.com/~richard/poky/sources/*. Is something wrong?
+ I see lots of 404 responses for files on http://pokylinux.org/sources/*. Is something wrong?
</para>
</question>
<answer>
@@ -278,7 +278,7 @@
</question>
<answer>
<para>
- The *-native targets are designed to run on the system the buil is running on. These are usually tools that are needed to assist the build in some way such as quilt-native which is used to apply patches. The non-native version is the one that would run on the target device.
+ The *-native targets are designed to run on the system the build is running on. These are usually tools that are needed to assist the build in some way such as quilt-native which is used to apply patches. The non-native version is the one that would run on the target device.
</para>
</answer>
</qandaentry>
diff --git a/handbook/ref-classes.xml b/handbook/ref-classes.xml
index dc7e38d51..770c062e7 100644
--- a/handbook/ref-classes.xml
+++ b/handbook/ref-classes.xml
@@ -11,9 +11,9 @@
file. Class files are identified by the extension
<filename class="extension">.bbclass</filename> and are usually placed
in a <filename class="directory">classes/</filename> directory beneath the
- <filename class="directory">meta/</filename> directory or the <filename
- class="directory">build/</filename> directory in the same way as <filename
- class="extension">.conf</filename> files in the <filename
+ <filename class="directory">meta*/</filename> directory or the directory pointed
+ by BUILDDIR (e.g. <filename class="directory">build/</filename>)in the same way as
+ <filename class="extension">.conf</filename> files in the <filename
class="directory">conf</filename> directory. Class files are searched for
in BBPATH in the same was as <filename class="extension">.conf</filename> files too.
</para>
@@ -34,10 +34,8 @@
(runs any Makefile present), installing (empty by default) and packaging
(empty by default). These are often overridden or extended by other classes
such as <filename>autotools.bbclass</filename> or
- <filename>package.bbclass</filename>. The class contains some commonly
- some commonly used functions such as <function>oe_libinstall</function>
- and <function>oe_runmake</function>. The end of the class file has a
- list of standard mirrors for software projects for use by the fetcher code.
+ <filename>package.bbclass</filename>. The class also contains some commonly
+ used functions such as <function>oe_runmake</function>.
</para>
</section>
@@ -55,14 +53,14 @@
</para>
<para>
- Its useful to have some idea of the tasks this class defines work and
- what they do behind the scenes.
+ It's useful to have some idea on how the tasks defined by this class work
+ and what they do behind the scenes.
</para>
<itemizedlist>
<listitem>
<para>
- 'do_configure' regenearates the configure script and
+ 'do_configure' regenearates the configure script and (using autoreconf)
then launches it with a standard set of arguments used during
cross-compilation. Additional parameters can be passed to
<command>configure</command> through the <glossterm><link
@@ -86,16 +84,6 @@
</listitem>
</itemizedlist>
- <para>
- By default the class does not stage headers and libraries so
- the recipe author needs to add their own <function>do_stage()</function>
- task. For typical recipes the following example code will usually be
- enough:
- <programlisting>
-do_stage() {
-autotools_stage_all
-}</programlisting>
- </para>
</section>
<section id='ref-classes-update-alternatives'>
@@ -150,6 +138,10 @@ autotools_stage_all
</listitem>
</varlistentry>
</variablelist>
+
+ <para>
+ Currently, only one binary per package is supported.
+ </para>
</section>
<section id='ref-classes-update-rc.d'>
@@ -171,7 +163,7 @@ autotools_stage_all
<title>Binary config scripts - <filename>binconfig.bbclass</filename></title>
<para>
- Before pkg-config became widespread, libraries shipped shell
+ Before pkg-config had become widespread, libraries shipped shell
scripts to give information about the libraries and include paths needed
to build software (usually named 'LIBNAME-config'). This class assists
any recipe using such scripts.
@@ -305,8 +297,8 @@ autotools_stage_all
output. The core generic functionality is in
<filename>package.bbclass</filename>, code specific to particular package
types is contained in various sub classes such as
- <filename>package_deb.bbclass</filename> and <filename>package_ipk.bbclass</filename>.
- Most users will
+ <filename>package_deb.bbclass</filename>, <filename>package_ipk.bbclass</filename>
+ and <filename>package_rpm.bbclass</filename>. Most users will
want one or more of these classes and this is controlled by the <glossterm>
<link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></glossterm>
variable. The first class listed in this variable will be used for image
@@ -326,10 +318,10 @@ autotools_stage_all
directory to allow building of out-of-tree modules using <filename>module.bbclass</filename>.
</para>
<para>
- The means that each kerel module built is packaged separately and inter-module dependencies are
+ This means that each kernel module built is packaged separately and inter-module dependencies are
created by parsing the <command>modinfo</command> output. If all modules are
required then installing the "kernel-modules" package will install all
- packages with modules and various other kernel packages such as "kernel-vmlinux" are also generated.
+ packages with modules and various other kernel packages such as "kernel-vmlinux".
</para>
<para>
@@ -362,11 +354,11 @@ autotools_stage_all
<title>Host System sanity checks - <filename>sanity.bbclass</filename></title>
<para>
- This class checks prerequisite software is present to try and identify
- and notify the user of problems which will affect their build. It also
- performs basic checks of the users configuration from local.conf to
- prevent common mistakes and resulting build failures. Its usually up to
- distribution policy to include this class (Poky does).
+ 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
+ prevent common mistakes resulting in build failures. It's usually up to
+ distribution policy whether to include this class (Poky does).
</para>
</section>
@@ -376,10 +368,9 @@ autotools_stage_all
<para>
This class adds a step to package generation which sanity checks the
packages generated by Poky. There are an ever increasing range of checks
- this makes, checking for common problems which break builds/packages/images,
- see the bbclass file for more information. Its usually up to distribution
- policy to include this class (Poky does).
- to soon).
+ it performs, checking for common problems which break builds/packages/images,
+ see the bbclass file for more information. It's usually up to distribution
+ policy whether to include this class (Poky does).
</para>
</section>
@@ -421,6 +412,7 @@ autotools_stage_all
bootimg.bbclass
ccache.inc
ccdv.bbclass
+ cmake.bbclass
cml1.bbclass
cross.bbclass
flow-lossage.bbclass
@@ -430,6 +422,7 @@ autotools_stage_all
gtk-icon-cache.bbclass
icecc.bbclass
lib_package.bbclass
+ mirrors.bbclass
mozilla.bbclass
multimachine.bbclass
native.bbclass
@@ -450,6 +443,7 @@ autotools_stage_all
syslinux.bbclass
tinderclient.bbclass
tmake.bbclass
+ utils.bbclass
xfce.bbclass
xlibs.bbclass
-->
diff --git a/handbook/resources.xml b/handbook/resources.xml
index da664f652..7561669fb 100644
--- a/handbook/resources.xml
+++ b/handbook/resources.xml
@@ -19,7 +19,7 @@
<para>
Problems with Poky should be reported in the
- <ulink url='http://bugzilla.o-hand.com/'>bug tracker</ulink>.
+ <ulink url='http://bugzilla.pokylinux.org/'>bug tracker</ulink>.
</para>
</section>
@@ -127,10 +127,10 @@ poky+subscribe &lt;at&gt; openedhand &lt;dot&gt; com
</programlisting>
<para>
- A Poky contributions tree (poky-contrib) exists for people to stage
- contributions in, for regular contributors. If people desire such
- access, please ask on the mailing list. Usually access will be given
- to anyone with a proven track record of good patches.
+ A Poky contributions tree (poky-contrib, git://git.pokylinux.org/poky-contrib.git)
+ exists for people to stage contributions in, for regular contributors.
+ If people desire such access, please ask on the mailing list. Usually
+ access will be given to anyone with a proven track record of good patches.
</para>
</section>