summaryrefslogtreecommitdiffstats
path: root/handbook/ref-classes.xml
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/ref-classes.xml
parent3c6e1d7c623672f6424508fd0ebbe795265a0fe0 (diff)
downloadpoky-a6e76529448d5b5c70988fcfe3b9f4beb022b784.tar.gz
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/ref-classes.xml')
-rw-r--r--handbook/ref-classes.xml62
1 files changed, 28 insertions, 34 deletions
diff --git a/handbook/ref-classes.xml b/handbook/ref-classes.xml
index dc7e38d51e..770c062e71 100644
--- a/handbook/ref-classes.xml
+++ b/handbook/ref-classes.xml
@@ -11,9 +11,9 @@
11 file. Class files are identified by the extension 11 file. Class files are identified by the extension
12 <filename class="extension">.bbclass</filename> and are usually placed 12 <filename class="extension">.bbclass</filename> and are usually placed
13 in a <filename class="directory">classes/</filename> directory beneath the 13 in a <filename class="directory">classes/</filename> directory beneath the
14 <filename class="directory">meta/</filename> directory or the <filename 14 <filename class="directory">meta*/</filename> directory or the directory pointed
15 class="directory">build/</filename> directory in the same way as <filename 15 by BUILDDIR (e.g. <filename class="directory">build/</filename>)in the same way as
16 class="extension">.conf</filename> files in the <filename 16 <filename class="extension">.conf</filename> files in the <filename
17 class="directory">conf</filename> directory. Class files are searched for 17 class="directory">conf</filename> directory. Class files are searched for
18 in BBPATH in the same was as <filename class="extension">.conf</filename> files too. 18 in BBPATH in the same was as <filename class="extension">.conf</filename> files too.
19</para> 19</para>
@@ -34,10 +34,8 @@
34 (runs any Makefile present), installing (empty by default) and packaging 34 (runs any Makefile present), installing (empty by default) and packaging
35 (empty by default). These are often overridden or extended by other classes 35 (empty by default). These are often overridden or extended by other classes
36 such as <filename>autotools.bbclass</filename> or 36 such as <filename>autotools.bbclass</filename> or
37 <filename>package.bbclass</filename>. The class contains some commonly 37 <filename>package.bbclass</filename>. The class also contains some commonly
38 some commonly used functions such as <function>oe_libinstall</function> 38 used functions such as <function>oe_runmake</function>.
39 and <function>oe_runmake</function>. The end of the class file has a
40 list of standard mirrors for software projects for use by the fetcher code.
41 </para> 39 </para>
42</section> 40</section>
43 41
@@ -55,14 +53,14 @@
55 </para> 53 </para>
56 54
57 <para> 55 <para>
58 Its useful to have some idea of the tasks this class defines work and 56 It's useful to have some idea on how the tasks defined by this class work
59 what they do behind the scenes. 57 and what they do behind the scenes.
60 </para> 58 </para>
61 59
62 <itemizedlist> 60 <itemizedlist>
63 <listitem> 61 <listitem>
64 <para> 62 <para>
65 'do_configure' regenearates the configure script and 63 'do_configure' regenearates the configure script and (using autoreconf)
66 then launches it with a standard set of arguments used during 64 then launches it with a standard set of arguments used during
67 cross-compilation. Additional parameters can be passed to 65 cross-compilation. Additional parameters can be passed to
68 <command>configure</command> through the <glossterm><link 66 <command>configure</command> through the <glossterm><link
@@ -86,16 +84,6 @@
86 </listitem> 84 </listitem>
87 </itemizedlist> 85 </itemizedlist>
88 86
89 <para>
90 By default the class does not stage headers and libraries so
91 the recipe author needs to add their own <function>do_stage()</function>
92 task. For typical recipes the following example code will usually be
93 enough:
94 <programlisting>
95do_stage() {
96autotools_stage_all
97}</programlisting>
98 </para>
99</section> 87</section>
100 88
101<section id='ref-classes-update-alternatives'> 89<section id='ref-classes-update-alternatives'>
@@ -150,6 +138,10 @@ autotools_stage_all
150 </listitem> 138 </listitem>
151 </varlistentry> 139 </varlistentry>
152 </variablelist> 140 </variablelist>
141
142 <para>
143 Currently, only one binary per package is supported.
144 </para>
153</section> 145</section>
154 146
155<section id='ref-classes-update-rc.d'> 147<section id='ref-classes-update-rc.d'>
@@ -171,7 +163,7 @@ autotools_stage_all
171 <title>Binary config scripts - <filename>binconfig.bbclass</filename></title> 163 <title>Binary config scripts - <filename>binconfig.bbclass</filename></title>
172 164
173 <para> 165 <para>
174 Before pkg-config became widespread, libraries shipped shell 166 Before pkg-config had become widespread, libraries shipped shell
175 scripts to give information about the libraries and include paths needed 167 scripts to give information about the libraries and include paths needed
176 to build software (usually named 'LIBNAME-config'). This class assists 168 to build software (usually named 'LIBNAME-config'). This class assists
177 any recipe using such scripts. 169 any recipe using such scripts.
@@ -305,8 +297,8 @@ autotools_stage_all
305 output. The core generic functionality is in 297 output. The core generic functionality is in
306 <filename>package.bbclass</filename>, code specific to particular package 298 <filename>package.bbclass</filename>, code specific to particular package
307 types is contained in various sub classes such as 299 types is contained in various sub classes such as
308 <filename>package_deb.bbclass</filename> and <filename>package_ipk.bbclass</filename>. 300 <filename>package_deb.bbclass</filename>, <filename>package_ipk.bbclass</filename>
309 Most users will 301 and <filename>package_rpm.bbclass</filename>. Most users will
310 want one or more of these classes and this is controlled by the <glossterm> 302 want one or more of these classes and this is controlled by the <glossterm>
311 <link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></glossterm> 303 <link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></glossterm>
312 variable. The first class listed in this variable will be used for image 304 variable. The first class listed in this variable will be used for image
@@ -326,10 +318,10 @@ autotools_stage_all
326 directory to allow building of out-of-tree modules using <filename>module.bbclass</filename>. 318 directory to allow building of out-of-tree modules using <filename>module.bbclass</filename>.
327 </para> 319 </para>
328 <para> 320 <para>
329 The means that each kerel module built is packaged separately and inter-module dependencies are 321 This means that each kernel module built is packaged separately and inter-module dependencies are
330 created by parsing the <command>modinfo</command> output. If all modules are 322 created by parsing the <command>modinfo</command> output. If all modules are
331 required then installing the "kernel-modules" package will install all 323 required then installing the "kernel-modules" package will install all
332 packages with modules and various other kernel packages such as "kernel-vmlinux" are also generated. 324 packages with modules and various other kernel packages such as "kernel-vmlinux".
333 </para> 325 </para>
334 326
335 <para> 327 <para>
@@ -362,11 +354,11 @@ autotools_stage_all
362 <title>Host System sanity checks - <filename>sanity.bbclass</filename></title> 354 <title>Host System sanity checks - <filename>sanity.bbclass</filename></title>
363 355
364 <para> 356 <para>
365 This class checks prerequisite software is present to try and identify 357 This class checks prerequisite software is present to
366 and notify the user of problems which will affect their build. It also 358 notify the users problems that will affect their build. It also
367 performs basic checks of the users configuration from local.conf to 359 performs basic checks of the user configuration from local.conf to
368 prevent common mistakes and resulting build failures. Its usually up to 360 prevent common mistakes resulting in build failures. It's usually up to
369 distribution policy to include this class (Poky does). 361 distribution policy whether to include this class (Poky does).
370 </para> 362 </para>
371</section> 363</section>
372 364
@@ -376,10 +368,9 @@ autotools_stage_all
376 <para> 368 <para>
377 This class adds a step to package generation which sanity checks the 369 This class adds a step to package generation which sanity checks the
378 packages generated by Poky. There are an ever increasing range of checks 370 packages generated by Poky. There are an ever increasing range of checks
379 this makes, checking for common problems which break builds/packages/images, 371 it performs, checking for common problems which break builds/packages/images,
380 see the bbclass file for more information. Its usually up to distribution 372 see the bbclass file for more information. It's usually up to distribution
381 policy to include this class (Poky does). 373 policy whether to include this class (Poky does).
382 to soon).
383 </para> 374 </para>
384</section> 375</section>
385 376
@@ -421,6 +412,7 @@ autotools_stage_all
421 bootimg.bbclass 412 bootimg.bbclass
422 ccache.inc 413 ccache.inc
423 ccdv.bbclass 414 ccdv.bbclass
415 cmake.bbclass
424 cml1.bbclass 416 cml1.bbclass
425 cross.bbclass 417 cross.bbclass
426 flow-lossage.bbclass 418 flow-lossage.bbclass
@@ -430,6 +422,7 @@ autotools_stage_all
430 gtk-icon-cache.bbclass 422 gtk-icon-cache.bbclass
431 icecc.bbclass 423 icecc.bbclass
432 lib_package.bbclass 424 lib_package.bbclass
425 mirrors.bbclass
433 mozilla.bbclass 426 mozilla.bbclass
434 multimachine.bbclass 427 multimachine.bbclass
435 native.bbclass 428 native.bbclass
@@ -450,6 +443,7 @@ autotools_stage_all
450 syslinux.bbclass 443 syslinux.bbclass
451 tinderclient.bbclass 444 tinderclient.bbclass
452 tmake.bbclass 445 tmake.bbclass
446 utils.bbclass
453 xfce.bbclass 447 xfce.bbclass
454 xlibs.bbclass 448 xlibs.bbclass
455--> 449-->