1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 05:29:32 +00:00

overview-manual: Updated text for Image and SDK generation.

General improvements to both sections.

(From yocto-docs rev: 977fdeaf1258613c3dfc41d78c8125fdba9b2a24)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2018-05-09 11:43:48 -07:00
committed by Richard Purdie
parent 1211c01f82
commit bd3df79121
@@ -1507,9 +1507,9 @@
<para> <para>
Once packages are split and stored in the Package Feeds Once packages are split and stored in the Package Feeds
area, the OpenEmbedded build system uses BitBake to area, the build system uses BitBake to generate the root
generate the root filesystem image: filesystem image:
<imagedata fileref="figures/image-generation.png" align="center" width="6in" depth="7in" /> <imagedata fileref="figures/image-generation.png" align="center" width="7.5in" depth="7.5in" />
</para> </para>
<para> <para>
@@ -1524,12 +1524,13 @@
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
<ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>: <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>:
Lists out the base set of packages to install from Lists out the base set of packages from which to
the Package Feeds area. install from the Package Feeds area.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></ulink>: <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></ulink>:
Specifies packages that should not be installed. Specifies packages that should not be installed
into the image.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>: <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>:
@@ -1539,9 +1540,9 @@
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>: <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>:
Specifies the package backend to use and Specifies the package backend (e.g. RPM, DEB, or
consequently helps determine where to locate IPK) to use and consequently helps determine where
packages within the Package Feeds area. to locate packages within the Package Feeds area.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></ulink>: <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></ulink>:
@@ -1550,8 +1551,8 @@
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
<ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></ulink>: <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></ulink>:
The final list of packages passed to the package manager The final list of packages passed to the package
for installation into the image. manager for installation into the image.
</para></listitem> </para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
@@ -1574,15 +1575,15 @@
enabled for the target, the package manager's data files enabled for the target, the package manager's data files
are deleted from the root filesystem. are deleted from the root filesystem.
As part of the final stage of package installation, As part of the final stage of package installation,
postinstall scripts that are part of the packages are run. post installation scripts that are part of the packages
Any scripts that fail to run are run.
on the build host are run on the target when the target Any scripts that fail to run on the build host are run on
system is first booted. the target when the target system is first booted.
If you are using a If you are using a
<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>read-only root filesystem</ulink>, <ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>read-only root filesystem</ulink>,
all the post installation scripts must succeed during the all the post installation scripts must succeed on the
package installation phase since the root filesystem is build host during the package installation phase since the
read-only. root filesystem on the target is read-only.
</para> </para>
<para> <para>
@@ -1606,7 +1607,7 @@
</para> </para>
<para> <para>
Optimizing processes run across the image include Optimizing processes that are run across the image include
<filename>mklibs</filename>, <filename>prelink</filename>, <filename>mklibs</filename>, <filename>prelink</filename>,
and any other post-processing commands as defined by the and any other post-processing commands as defined by the
<ulink url='&YOCTO_DOCS_REF_URL;#var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></ulink>
@@ -1627,12 +1628,11 @@
<ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></ulink>
variable. variable.
This variable specifies a list of functions to call before This variable specifies a list of functions to call before
the OpenEmbedded build system creates the final image the build system creates the final image output files.
output files.
</para> </para>
<para> <para>
The OpenEmbedded build system dynamically creates The build system dynamically creates
<filename>do_image_*</filename> tasks as needed, based <filename>do_image_*</filename> tasks as needed, based
on the image types specified in the on the image types specified in the
<ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></ulink>
@@ -1671,11 +1671,10 @@
<ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></ulink>
variable. variable.
The variable specifies a list of functions to call once the The variable specifies a list of functions to call once the
OpenEmbedded build system has created the final image build system has created the final image output files.
output files.
<note> <note>
The entire image generation process is run under The entire image generation process is run under
Pseudo. <link linkend='fakeroot-and-pseudo'>Pseudo</link>.
Running under Pseudo ensures that the files in the Running under Pseudo ensures that the files in the
root filesystem have correct ownership. root filesystem have correct ownership.
</note> </note>
@@ -1687,9 +1686,12 @@
<para> <para>
The OpenEmbedded build system uses BitBake to generate the The OpenEmbedded build system uses BitBake to generate the
Software Development Kit (SDK) installer script for both Software Development Kit (SDK) installer scripts for both
the standard and extensible SDKs: the standard SDK and the extensible SDK (eSDK):
<imagedata fileref="figures/sdk-generation.png" align="center" /> </para>
<para>
<imagedata fileref="figures/sdk-generation.png" width="9in" align="center" />
<note> <note>
For more information on the cross-development toolchain For more information on the cross-development toolchain
generation, see the generation, see the
@@ -1701,7 +1703,7 @@
task, see the task, see the
"<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>"
section in the Yocto Project Application Development section in the Yocto Project Application Development
and the Extensible Software Development Kit (SDK) and the Extensible Software Development Kit (eSDK)
manual. manual.
</note> </note>
</para> </para>
@@ -1709,10 +1711,12 @@
<para> <para>
Like image generation, the SDK script process consists of Like image generation, the SDK script process consists of
several stages and depends on many variables. several stages and depends on many variables.
The <filename>do_populate_sdk</filename> and The
<filename>do_populate_sdk_ext</filename> tasks use these <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></ulink>
key variables to help create the list of packages to and
actually install. <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-populate_sdk_ext'><filename>do_populate_sdk_ext</filename></ulink>
tasks use these key variables to help create the list of
packages to actually install.
For information on the variables listed in the figure, For information on the variables listed in the figure,
see the see the
"<link linkend='sdk-dev-environment'>Application Development SDK</link>" "<link linkend='sdk-dev-environment'>Application Development SDK</link>"