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/ref-manual | |
| parent | 6b58ab391b307f60f6156a9fd35e3a752dce980b (diff) | |
| download | 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/ref-manual')
| -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 8e49c4d689..5e7fad3ea2 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
| @@ -45,7 +45,7 @@ | |||
| 45 | <title><filename>allarch.bbclass</filename></title> | 45 | <title><filename>allarch.bbclass</filename></title> |
| 46 | 46 | ||
| 47 | <para> | 47 | <para> |
| 48 | The all architecture (<filename>allarch</filename>) class is inherited | 48 | The <filename>allarch</filename> class is inherited |
| 49 | by recipes that do not produce architecture-specific output. | 49 | by recipes that do not produce architecture-specific output. |
| 50 | The class disables functionality that is normally needed for recipes | 50 | The class disables functionality that is normally needed for recipes |
| 51 | that produce executable binaries (such as building the cross-compiler | 51 | that produce executable binaries (such as building the cross-compiler |
| @@ -137,7 +137,7 @@ | |||
| 137 | 137 | ||
| 138 | <para> | 138 | <para> |
| 139 | The <filename>base</filename> class is special in that every | 139 | The <filename>base</filename> class is special in that every |
| 140 | <filename>.bb</filename> file automatically inherits the class. | 140 | <filename>.bb</filename> file implicitly inherits the class. |
| 141 | This class contains definitions for standard basic | 141 | This class contains definitions for standard basic |
| 142 | tasks such as fetching, unpacking, configuring (empty by default), | 142 | tasks such as fetching, unpacking, configuring (empty by default), |
| 143 | compiling (runs any <filename>Makefile</filename> present), installing | 143 | compiling (runs any <filename>Makefile</filename> present), installing |
| @@ -166,8 +166,9 @@ | |||
| 166 | <note> | 166 | <note> |
| 167 | For RPMs and other packages that do not contain a subdirectory, | 167 | For RPMs and other packages that do not contain a subdirectory, |
| 168 | you should specify a "subdir" parameter. | 168 | you should specify a "subdir" parameter. |
| 169 | Here is an example where <filename>${BP}</filename> matches the | 169 | Here is an example where <filename>${BP}</filename> is used so that |
| 170 | subdirectory expected by the default value of | 170 | the files are extracted into the subdirectory expected by the |
| 171 | default value of | ||
| 171 | <link linkend='var-S'><filename>S</filename></link>: | 172 | <link linkend='var-S'><filename>S</filename></link>: |
| 172 | <literallayout class='monospaced'> | 173 | <literallayout class='monospaced'> |
| 173 | SRC_URI = "http://example.com/downloads/somepackage.rpm;subdir=${BP}" | 174 | SRC_URI = "http://example.com/downloads/somepackage.rpm;subdir=${BP}" |
| @@ -290,10 +291,11 @@ | |||
| 290 | <title><filename>bugzilla.bbclass</filename></title> | 291 | <title><filename>bugzilla.bbclass</filename></title> |
| 291 | 292 | ||
| 292 | <para> | 293 | <para> |
| 293 | The <filename>bugzilla</filename> class, if enabled in | 294 | The <filename>bugzilla</filename> class automatically files bug reports |
| 294 | your instance of Bugzilla, automatically files bug reports to that | 295 | to a Bugzilla instance in response to build failures. |
| 295 | enabled instance in response to build failures. | ||
| 296 | This class uses Bugzilla's XML-RPC interface. | 296 | This class uses Bugzilla's XML-RPC interface. |
| 297 | Consequently, you need to enable the class in the instance of Bugzilla | ||
| 298 | within which you wish to file reports. | ||
| 297 | </para> | 299 | </para> |
| 298 | </section> | 300 | </section> |
| 299 | 301 | ||
| @@ -330,13 +332,12 @@ | |||
| 330 | </para> | 332 | </para> |
| 331 | 333 | ||
| 332 | <para> | 334 | <para> |
| 333 | To enable this class, use the | 335 | Collecting build statistics is enabled by default through the |
| 334 | <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link> | 336 | <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link> |
| 335 | variable from your <filename>local.conf</filename> file. | 337 | variable from your <filename>local.conf</filename> file. |
| 336 | The <filename>meta-yocto/conf/local.conf.sample</filename> file | 338 | Consequently, you do not have to do anything to enable the class. |
| 337 | in the | 339 | However, if you want to disable the class, simply remove "buildstats" |
| 338 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | 340 | from the <filename>USER_CLASSES</filename> list. |
| 339 | enables this class by default. | ||
| 340 | </para> | 341 | </para> |
| 341 | </section> | 342 | </section> |
| 342 | 343 | ||
