diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-12-06 08:20:09 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-11 14:19:28 +0000 |
commit | bc6b005b0c2ba001d061acc585589b6e5642f8f8 (patch) | |
tree | 744ee4c8e8d7872d52e92c8767b8d8d38d3315fd /documentation | |
parent | 6b58ab391b307f60f6156a9fd35e3a752dce980b (diff) | |
download | ast2050-yocto-poky-bc6b005b0c2ba001d061acc585589b6e5642f8f8.zip ast2050-yocto-poky-bc6b005b0c2ba001d061acc585589b6e5642f8f8.tar.gz |
ref-manual: Review edits to classes A through B
Applied some review edits from Paul Eggleton for the following
classes:
allarch
base
bin_package
bugzilla
buildstats
(From yocto-docs rev: fe6b688106c5444fe6306326751ce636894acfd3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 8e49c4d..5e7fad3 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -45,7 +45,7 @@ <title><filename>allarch.bbclass</filename></title> <para> - The all architecture (<filename>allarch</filename>) class is inherited + The <filename>allarch</filename> class is inherited by recipes that do not produce architecture-specific output. The class disables functionality that is normally needed for recipes that produce executable binaries (such as building the cross-compiler @@ -137,7 +137,7 @@ <para> The <filename>base</filename> class is special in that every - <filename>.bb</filename> file automatically inherits the class. + <filename>.bb</filename> file implicitly inherits the class. This class contains definitions for standard basic tasks such as fetching, unpacking, configuring (empty by default), compiling (runs any <filename>Makefile</filename> present), installing @@ -166,8 +166,9 @@ <note> For RPMs and other packages that do not contain a subdirectory, you should specify a "subdir" parameter. - Here is an example where <filename>${BP}</filename> matches the - subdirectory expected by the default value of + Here is an example where <filename>${BP}</filename> is used so that + the files are extracted into the subdirectory expected by the + default value of <link linkend='var-S'><filename>S</filename></link>: <literallayout class='monospaced'> SRC_URI = "http://example.com/downloads/somepackage.rpm;subdir=${BP}" @@ -290,10 +291,11 @@ <title><filename>bugzilla.bbclass</filename></title> <para> - The <filename>bugzilla</filename> class, if enabled in - your instance of Bugzilla, automatically files bug reports to that - enabled instance in response to build failures. + The <filename>bugzilla</filename> class automatically files bug reports + to a Bugzilla instance in response to build failures. This class uses Bugzilla's XML-RPC interface. + Consequently, you need to enable the class in the instance of Bugzilla + within which you wish to file reports. </para> </section> @@ -330,13 +332,12 @@ </para> <para> - To enable this class, use the + Collecting build statistics is enabled by default through the <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link> variable from your <filename>local.conf</filename> file. - The <filename>meta-yocto/conf/local.conf.sample</filename> file - in the - <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> - enables this class by default. + Consequently, you do not have to do anything to enable the class. + However, if you want to disable the class, simply remove "buildstats" + from the <filename>USER_CLASSES</filename> list. </para> </section> |