sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

ref-manual: add documentation for rm_work.bbclass 

I rewrote the class description to conform to the existing
manual style.  Mainly making voice active and breaking up
long sentenced.

(From yocto-docs rev: e715167e280eb647be52c142f733942dab3f4dfb)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Eggleton 2013-04-03 21:02:05 +01:00 committed by Richard Purdie
parent 52ac480974
commit c3ecfdb707
1 changed files with 36 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
documentation/ref-manual/ref-classes.xml
View File

@ -538,6 +538,42 @@
</para>
</section>
<section id='ref-classes-rm-work'>
<title>Removing work files during the build - <filename>rm_work.bbclass</filename></title>
<para>
The OpenEmbedded build system can use a substantial amount of disk
space during the build process.
A portion of this space is the work files under the
<filename>${TMPDIR}/work</filename> directory for each recipe.
Once the build system generates the packages for a recipe, the work
files for that recipe are no longer needed.
However, by default, the build system preserves these files
for inspection and possible debugging purposes.
If you would rather have these files deleted to save disk space
as the build progresses, you can enable <filename>rm_work</filename>
by adding the following to your <filename>local.conf</filename> file,
which is found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<literallayout class='monospaced'>
INHERIT += "rm_work"
</literallayout>
If you are modifying and building source code out of the work directory
for a recipe, enabling <filename>rm_work</filename> will potentially
result in your changes to the source being lost.
To exclude some recipes from having their work directories deleted by
<filename>rm_work</filename>, you can add the names of the recipe or
recipes you are working on to the <filename>RM_WORK_EXCLUDE</filename>
variable, which is also found in your <filename>local.conf</filename>
file.
Here is an example:
<literallayout class='monospaced'>
RM_WORK_EXCLUDE += "busybox eglibc"
</literallayout>
</para>
</section>
<section id='ref-classes-siteinfo'>
<title>Autotools Configuration Data Cache - <filename>siteinfo.bbclass</filename></title>
@ -732,7 +768,6 @@
qt4*.bbclass
recipe_sanity.bbclass
relocatable.bbclass
rm_work.bbclass
scons.bbclass
sdl.bbclass
setuptools.bbclass