diff options
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/ref-classes.xml | 32 | 
1 files changed, 31 insertions, 1 deletions
| diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index cab546a0ae..e8f5a2f72b 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
| @@ -332,12 +332,42 @@ | |||
| 332 | The Build History (<filename>buildhistory</filename>) class records a | 332 | The Build History (<filename>buildhistory</filename>) class records a | 
| 333 | history of build output metadata, which can be used to detect possible | 333 | history of build output metadata, which can be used to detect possible | 
| 334 | regressions as well as used for analysis of the build output. | 334 | regressions as well as used for analysis of the build output. | 
| 335 | For more information on usinig Build History, see the | 335 | For more information on using Build History, see the | 
| 336 | "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>" | 336 | "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>" | 
| 337 | section. | 337 | section. | 
| 338 | </para> | 338 | </para> | 
| 339 | </section> | 339 | </section> | 
| 340 | 340 | ||
| 341 | <section id='ref-classes-buildstats'> | ||
| 342 | <title><filename>buildstats.bbclass</filename></title> | ||
| 343 | |||
| 344 | <para> | ||
| 345 | The Build Stats (<filename>buildstats</filename>) class records | ||
| 346 | performance statistics about each task executed during the build | ||
| 347 | (e.g. elapsed time, CPU usage, and I/O usage). | ||
| 348 | </para> | ||
| 349 | |||
| 350 | <para> | ||
| 351 | When you use this class, the output goes into the | ||
| 352 | <link linkend='var-BUILDSTATS_BASE'><filename>BUILDSTATS_BASE</filename></link> | ||
| 353 | directory, which defaults to <filename>${TMPDIR}/buildstats/</filename>. | ||
| 354 | You can analyze the elapsed time using | ||
| 355 | <filename>scripts/pybootchartgui/pybootchartgui.py</filename>, which | ||
| 356 | produces a cascading chart of the entire build process and can be | ||
| 357 | useful for highlighting bottlenecks. | ||
| 358 | </para> | ||
| 359 | |||
| 360 | <para> | ||
| 361 | To enable this class, use the | ||
| 362 | <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link> | ||
| 363 | variable from your <filename>local.conf</filename> file. | ||
| 364 | The <filename>meta-yocto/conf/local.conf.sample</filename> file | ||
| 365 | in the | ||
| 366 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | ||
| 367 | enables this class by default. | ||
| 368 | </para> | ||
| 369 | </section> | ||
| 370 | |||
| 341 | <section id='ref-classes-debian'> | 371 | <section id='ref-classes-debian'> | 
| 342 | <title>Debian Renaming - <filename>debian.bbclass</filename></title> | 372 | <title>Debian Renaming - <filename>debian.bbclass</filename></title> | 
| 343 | 373 | ||
