summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@linux.intel.com>2013-04-03 21:02:05 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-13 23:57:20 +0100
commite1b96f05ca3a0def5bc9e34fc1fcd6cbe78fdd1c (patch)
treea03453baa98ce3dc0ac59df53b87650a28480fe3 /documentation
parent92a758a9ee18a0743e981f22b12b824c922986ab (diff)
downloadpoky-e1b96f05ca3a0def5bc9e34fc1fcd6cbe78fdd1c.tar.gz
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>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-classes.xml37
1 files changed, 36 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index a03a68b6e9..acda0da063 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -538,6 +538,42 @@
538 </para> 538 </para>
539</section> 539</section>
540 540
541<section id='ref-classes-rm-work'>
542 <title>Removing work files during the build - <filename>rm_work.bbclass</filename></title>
543
544 <para>
545 The OpenEmbedded build system can use a substantial amount of disk
546 space during the build process.
547 A portion of this space is the work files under the
548 <filename>${TMPDIR}/work</filename> directory for each recipe.
549 Once the build system generates the packages for a recipe, the work
550 files for that recipe are no longer needed.
551 However, by default, the build system preserves these files
552 for inspection and possible debugging purposes.
553 If you would rather have these files deleted to save disk space
554 as the build progresses, you can enable <filename>rm_work</filename>
555 by adding the following to your <filename>local.conf</filename> file,
556 which is found in the
557 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
558 <literallayout class='monospaced'>
559 INHERIT += "rm_work"
560 </literallayout>
561 If you are modifying and building source code out of the work directory
562 for a recipe, enabling <filename>rm_work</filename> will potentially
563 result in your changes to the source being lost.
564 To exclude some recipes from having their work directories deleted by
565 <filename>rm_work</filename>, you can add the names of the recipe or
566 recipes you are working on to the <filename>RM_WORK_EXCLUDE</filename>
567 variable, which is also found in your <filename>local.conf</filename>
568 file.
569 Here is an example:
570 <literallayout class='monospaced'>
571 RM_WORK_EXCLUDE += "busybox eglibc"
572 </literallayout>
573 </para>
574</section>
575
576
541<section id='ref-classes-siteinfo'> 577<section id='ref-classes-siteinfo'>
542 <title>Autotools Configuration Data Cache - <filename>siteinfo.bbclass</filename></title> 578 <title>Autotools Configuration Data Cache - <filename>siteinfo.bbclass</filename></title>
543 579
@@ -732,7 +768,6 @@
732 qt4*.bbclass 768 qt4*.bbclass
733 recipe_sanity.bbclass 769 recipe_sanity.bbclass
734 relocatable.bbclass 770 relocatable.bbclass
735 rm_work.bbclass
736 scons.bbclass 771 scons.bbclass
737 sdl.bbclass 772 sdl.bbclass
738 setuptools.bbclass 773 setuptools.bbclass