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

ref-manual: Updated the ROOTFS_POSTPROCESS_COMMAND variable description. 

Fixes [YOCTO #2808]

Review comments from Paul.

(From yocto-docs rev: d8ab45eb0533ccbcc9ec34105b5fe4163122bc4a)

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-09-16 10:11:28 -07:00 committed by Richard Purdie
parent 7b0c340926
commit 597aceb920
1 changed files with 47 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -714,7 +714,7 @@ Core layer for images cannot be removed
<glossdef> <glossdef>
<para> <para>
Points to the server that runs memory-resident BitBake. Points to the server that runs memory-resident BitBake.
This variable is set by the This variable is set by the
<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>
setup script and should not be hand-edited. setup script and should not be hand-edited.
The variable is only used when you employ memory-resident The variable is only used when you employ memory-resident
@ -723,10 +723,10 @@ Core layer for images cannot be removed
<literallayout class='monospaced'> <literallayout class='monospaced'>
export BBSERVER=localhost:$port export BBSERVER=localhost:$port
</literallayout> </literallayout>
For more information on how the For more information on how the
<filename>BBSERVER</filename> is used, see the <filename>BBSERVER</filename> is used, see the
<filename>oe-init-build-env-memres</filename> script, which <filename>oe-init-build-env-memres</filename> script, which
is located in the is located in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</para> </para>
</glossdef> </glossdef>
@ -789,9 +789,9 @@ Core layer for images cannot be removed
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
You can define this directory indirectly through the You can define this directory indirectly through the
<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
and and
<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>
scripts by passing in a Build Directory path when you run scripts by passing in a Build Directory path when you run
the scripts. the scripts.
If you run the scripts and do not provide a Build Directory If you run the scripts and do not provide a Build Directory
path, the <filename>BUILDDIR</filename> defaults to path, the <filename>BUILDDIR</filename> defaults to
@ -1230,39 +1230,39 @@ Core layer for images cannot be removed
<glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm>
<glossdef> <glossdef>
<para> <para>
The central download directory used by the build process to The central download directory used by the build process to
store downloads. store downloads.
You can set this directory by defining the You can set this directory by defining the
<filename>DL_DIR</filename> variable in the <filename>DL_DIR</filename> variable in the
<filename>/conf/local.conf</filename> file. <filename>/conf/local.conf</filename> file.
This directory is self-maintaining and you should not have This directory is self-maintaining and you should not have
to touch it. to touch it.
By default, the directory is <filename>downloads</filename> By default, the directory is <filename>downloads</filename>
in the in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<literallayout class='monospaced'> <literallayout class='monospaced'>
#DL_DIR ?= "${TOPDIR}/downloads" #DL_DIR ?= "${TOPDIR}/downloads"
</literallayout> </literallayout>
To specify a different download directory, simply remove To specify a different download directory, simply remove
the comment from the line and provide your directory. the comment from the line and provide your directory.
</para> </para>
<para> <para>
During a first build, the system downloads many different During a first build, the system downloads many different
source code tarballs from various upstream projects. source code tarballs from various upstream projects.
Downloading can take a while, particularly if your network Downloading can take a while, particularly if your network
connection is slow. connection is slow.
Tarballs are all stored in the directory defined by Tarballs are all stored in the directory defined by
<filename>DL_DIR</filename> and the build system looks there <filename>DL_DIR</filename> and the build system looks there
first to find source tarballs. first to find source tarballs.
<note> <note>
When wiping and rebuilding, you can preserve this When wiping and rebuilding, you can preserve this
directory to speed up this part of subsequent builds. directory to speed up this part of subsequent builds.
</note> </note>
</para> </para>
<para> <para>
You can safely share this directory between multiple builds You can safely share this directory between multiple builds
on the same development machine. on the same development machine.
For additional information on how the build process gets For additional information on how the build process gets
source files when working behind a firewall or proxy server, source files when working behind a firewall or proxy server,
@ -1801,25 +1801,25 @@ Core layer for images cannot be removed
<glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm> <glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm>
<glossdef> <glossdef>
<para> <para>
A list of classes that all images should inherit. A list of classes that all images should inherit.
You typically use this variable to specify the list of You typically use this variable to specify the list of
classes that register the different types of images classes that register the different types of images
the OpenEmbedded build system creates. the OpenEmbedded build system creates.
</para> </para>
<para> <para>
The default value for <filename>IMAGE_CLASSES</filename> is The default value for <filename>IMAGE_CLASSES</filename> is
<filename>image_types.bbclass</filename>. <filename>image_types.bbclass</filename>.
You can set this variable in your You can set this variable in your
<filename>local.conf</filename> or in a distribution <filename>local.conf</filename> or in a distribution
configuration file. configuration file.
</para> </para>
<para> <para>
For more information, see For more information, see
<filename>meta/classes/image_types.bbclass</filename> in the <filename>meta/classes/image_types.bbclass</filename> in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</para> </para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@ -1982,7 +1982,7 @@ Core layer for images cannot be removed
<glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm> <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm>
<glossdef> <glossdef>
<para> <para>
Added by classes to run post processing commands once the Added by classes to run post processing commands once the
OpenEmbedded build system has created the image. OpenEmbedded build system has created the image.
You can specify shell commands and, if necessary, the path You can specify shell commands and, if necessary, the path
to the root filesystem image: to the root filesystem image:
@ -1996,8 +1996,8 @@ Core layer for images cannot be removed
<glossentry id='var-IMAGE_ROOTFS'><glossterm>IMAGE_ROOTFS</glossterm> <glossentry id='var-IMAGE_ROOTFS'><glossterm>IMAGE_ROOTFS</glossterm>
<glossdef> <glossdef>
<para> <para>
The location of the root filesystem. The location of the root filesystem.
This variable is not configurable. This variable is not configurable.
Do not change it. Do not change it.
</para> </para>
</glossdef> </glossdef>
@ -3411,17 +3411,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
The directory from which the top-level build environment The directory from which the top-level build environment
setup script is sourced. setup script is sourced.
The Yocto Project makes two top-level build environment The Yocto Project makes two top-level build environment
setup scripts available: setup scripts available:
<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
and and
<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>. <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>.
When you run one of these scripts, the When you run one of these scripts, the
<filename>OEROOT</filename> variable resolves to the <filename>OEROOT</filename> variable resolves to the
directory that holds the script. directory that holds the script.
</para> </para>
<para> <para>
For additional information on how this variable is used, For additional information on how this variable is used,
see the initialization scripts. see the initialization scripts.
</para> </para>
</glossdef> </glossdef>
@ -3710,15 +3710,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<para> <para>
The default value of "noop" causes the build to simply fail The default value of "noop" causes the build to simply fail
when the OpenEmbedded build system cannot successfully when the OpenEmbedded build system cannot successfully
apply a patch. apply a patch.
Setting the value to "user" causes the build system to Setting the value to "user" causes the build system to
launch a shell and places you in the right location so that launch a shell and places you in the right location so that
you can manually resolve the conflicts. you can manually resolve the conflicts.
</para> </para>
<para> <para>
Set this variable in your Set this variable in your
<filename>local.conf</filename> file. <filename>local.conf</filename> file.
</para> </para>
</glossdef> </glossdef>
@ -4169,13 +4169,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-ROOTFS_POSTPROCESS_COMMAND'><glossterm>ROOTFS_POSTPROCESS_COMMAND</glossterm> <glossentry id='var-ROOTFS_POSTPROCESS_COMMAND'><glossterm>ROOTFS_POSTPROCESS_COMMAND</glossterm>
<glossdef> <glossdef>
<para> <para>
Added by classes to run post processing commands once the Added by classes to run post processing commands once the
OpenEmbedded build system has created the root filesystem. OpenEmbedded build system has created the root filesystem.
You can specify shell commands and, if necessary, the path You can specify shell commands and, if necessary, the path
to the root filesystem image: to the root filesystem image:
<literallayout class='monospaced'> <literallayout class='monospaced'>
ROOTFS_POSTPROCESS_COMMAND += "${IMAGE_ROOTFS}&lt;shell_command&gt;; ... " ROOTFS_POSTPROCESS_COMMAND += "&lt;shell_command&gt;; ... "
</literallayout> </literallayout>
If you need to pass the path to the root filesystem within
the command, you can use
<filename>${IMAGE_ROOTFS}</filename>, which points to
the root filesystem image.
</para> </para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@ -5167,22 +5171,22 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-USER_CLASSES'><glossterm>USER_CLASSES</glossterm> <glossentry id='var-USER_CLASSES'><glossterm>USER_CLASSES</glossterm>
<glossdef> <glossdef>
<para> <para>
A list of classes to globally inherit. A list of classes to globally inherit.
These classes are used by the OpenEmbedded build system These classes are used by the OpenEmbedded build system
to enable extra features (e.g. to enable extra features (e.g.
<filename>buildstats</filename>, <filename>buildstats</filename>,
<filename>image-mklibs</filename>, and so forth). <filename>image-mklibs</filename>, and so forth).
</para> </para>
<para> <para>
The default list is set in your The default list is set in your
<filename>local.conf</filename> file: <filename>local.conf</filename> file:
<literallayout class='monospaced'> <literallayout class='monospaced'>
USER_CLASSES ?= "buildstats image-mklibs image-prelink" USER_CLASSES ?= "buildstats image-mklibs image-prelink"
</literallayout> </literallayout>
For more information, see For more information, see
<filename>meta-yocto/conf/local.conf.sample</filename> in <filename>meta-yocto/conf/local.conf.sample</filename> in
the the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</para> </para>
</glossdef> </glossdef>