From a6e76529448d5b5c70988fcfe3b9f4beb022b784 Mon Sep 17 00:00:00 2001 From: Qing He Date: Thu, 9 Sep 2010 16:28:47 +0800 Subject: 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 Signed-off-by: Dongxiao Xu --- handbook/ref-classes.xml | 62 ++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 34 deletions(-) (limited to 'handbook/ref-classes.xml') 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 .bbclass and are usually placed in a classes/ directory beneath the - meta/ directory or the build/ directory in the same way as .conf files in the meta*/ directory or the directory pointed + by BUILDDIR (e.g. build/)in the same way as + .conf files in the conf directory. Class files are searched for in BBPATH in the same was as .conf files too. @@ -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 autotools.bbclass or - package.bbclass. The class contains some commonly - some commonly used functions such as oe_libinstall - and oe_runmake. The end of the class file has a - list of standard mirrors for software projects for use by the fetcher code. + package.bbclass. The class also contains some commonly + used functions such as oe_runmake. @@ -55,14 +53,14 @@ - 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. - '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 configure through the - - By default the class does not stage headers and libraries so - the recipe author needs to add their own do_stage() - task. For typical recipes the following example code will usually be - enough: - -do_stage() { -autotools_stage_all -} -
@@ -150,6 +138,10 @@ autotools_stage_all + + + Currently, only one binary per package is supported. +
@@ -171,7 +163,7 @@ autotools_stage_all Binary config scripts - <filename>binconfig.bbclass</filename> - 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 package.bbclass, code specific to particular package types is contained in various sub classes such as - package_deb.bbclass and package_ipk.bbclass. - Most users will + package_deb.bbclass, package_ipk.bbclass + and package_rpm.bbclass. Most users will want one or more of these classes and this is controlled by the PACKAGE_CLASSES 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 module.bbclass. - 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 modinfo 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". @@ -362,11 +354,11 @@ autotools_stage_all Host System sanity checks - <filename>sanity.bbclass</filename> - 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).
@@ -376,10 +368,9 @@ autotools_stage_all 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). @@ -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 --> -- cgit v1.2.3