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

ref-manual: Edits to rm_work class. 

(From yocto-docs rev: 89de6352a441f85532516e08883ba5d4620e0210)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2013-12-05 15:04:28 -06:00 committed by Richard Purdie
parent 2db4b6565d
commit d34ba8b56b
2 changed files with 62 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2262,6 +2262,67 @@
</para>
</section>
<section id='ref-classes-rm-work'>
<title><filename>rm_work.bbclass</filename></title>
<para>
The <filename>rm_work</filename> class supports deletion of temporary
workspace, which can ease your hard drive demands during builds.
</para>
<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 can also be set 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-rootfs*'>
<title><filename>rootfs*.bbclass</filename></title>
<para>
These classes add support for creating images in several formats.
First, the root filesystem is created from packages using
one of the <filename>rootfs_*.bbclass</filename>
files (depending on the package format used) and then the image is created.
<itemizedlist>
<listitem><para>The
<filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></filename>
variable controls the types of images to generate.
</para></listitem>
<listitem><para>The
<filename><link linkend='var-IMAGE_INSTALL'>IMAGE_INSTALL</link></filename>
variable controls the list of packages to install into the
image.</para></listitem>
</itemizedlist>
</para>
</section>
<section id='ref-classes-scons'>
<title><filename>scons.bbclass</filename></title>
@ -2459,27 +2520,6 @@
</para>
</section>
<section id='ref-classes-rootfs*'>
<title><filename>rootfs*.bbclass</filename></title>
<para>
These classes add support for creating images in several formats.
First, the root filesystem is created from packages using
one of the <filename>rootfs_*.bbclass</filename>
files (depending on the package format used) and then the image is created.
<itemizedlist>
<listitem><para>The
<filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></filename>
variable controls the types of images to generate.
</para></listitem>
<listitem><para>The
<filename><link linkend='var-IMAGE_INSTALL'>IMAGE_INSTALL</link></filename>
variable controls the list of packages to install into the
image.</para></listitem>
</itemizedlist>
</para>
</section>
<section id='ref-classes-sanity'>
<title>Host System Sanity Checks - <filename>sanity.bbclass</filename></title>
@ -2493,42 +2533,6 @@
</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 can also be set 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>

2
documentation/ref-manual/ref-variables.xml
View File

@ -5274,7 +5274,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
With <filename>rm_work</filename> enabled, this
variable specifies a list of recipes whose work directories
should not be removed.
See the "<link linkend='ref-classes-rm-work'>Removing Work Files During the Build - <filename>rm_work.bbclass</filename></link>"
See the "<link linkend='ref-classes-rm-work'><filename>rm_work.bbclass</filename></link>"
section for more details.
</para>
</glossdef>