overview-manual: Updates to the "Images" section.

Some minor rewrites.

(From yocto-docs rev: 71cbc1c389389ffac9e59faacdc56d3ea05facd7)

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 15:33:38 -07:00
committed by Richard Purdie
parent 6f90c96872
commit b20454dbdf

View File

@@ -1949,9 +1949,9 @@
<title>Images</title>
<para>
The images produced by the OpenEmbedded build system
are compressed forms of the
root filesystem that are ready to boot on a target device.
The images produced by the build system are compressed forms
of the root filesystem and are ready to boot on a target
device.
You can see from the
<link linkend='general-workflow-figure'>general workflow figure</link>
that BitBake output, in part, consists of images.
@@ -1959,15 +1959,15 @@
<imagedata fileref="figures/images.png" align="center" width="5.5in" depth="5.5in" />
</para>
<para>
<note>
For a list of example images that the Yocto Project provides,
see the
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
chapter in the Yocto Project Reference Manual.
</para>
</note>
<para>
Images are written out to the
The build process writes images out to the
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
inside the
<filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename>
@@ -1983,7 +1983,7 @@
for the current configuration.
<itemizedlist>
<listitem><para>
<filename><replaceable>kernel-image</replaceable></filename>:
<replaceable>kernel-image</replaceable>:
A kernel binary file.
The
<ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></ulink>
@@ -1992,12 +1992,12 @@
Depending on that variable, the file could begin with
a variety of naming strings.
The
<filename>deploy/images/<replaceable>machine</replaceable></filename>
<filename>deploy/images/</filename><replaceable>machine</replaceable>
directory can contain multiple image files for the
machine.
</para></listitem>
<listitem><para>
<filename><replaceable>root-filesystem-image</replaceable></filename>:
<replaceable>root-filesystem-image</replaceable>:
Root filesystems for the target device (e.g.
<filename>*.ext3</filename> or
<filename>*.bz2</filename> files).
@@ -2006,12 +2006,12 @@
variable setting determines the root filesystem image
type.
The
<filename>deploy/images/<replaceable>machine</replaceable></filename>
<filename>deploy/images/</filename><replaceable>machine</replaceable>
directory can contain multiple root filesystems for the
machine.
</para></listitem>
<listitem><para>
<filename><replaceable>kernel-modules</replaceable></filename>:
<replaceable>kernel-modules</replaceable>:
Tarballs that contain all the modules built for the
kernel.
Kernel module tarballs exist for legacy purposes and
@@ -2019,22 +2019,22 @@
<ulink url='&YOCTO_DOCS_REF_URL;#var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></ulink>
variable to "0".
The
<filename>deploy/images/<replaceable>machine</replaceable></filename>
<filename>deploy/images/</filename><replaceable>machine</replaceable>
directory can contain multiple kernel module tarballs
for the machine.
</para></listitem>
<listitem><para>
<filename><replaceable>bootloaders</replaceable></filename>:
Bootloaders supporting the image, if applicable to the
target machine.
The <filename>deploy/images/<replaceable>machine</replaceable></filename>
<replaceable>bootloaders</replaceable>:
If applicable to the target machine, bootloaders
supporting the image.
The <filename>deploy/images/</filename><replaceable>machine</replaceable>
directory can contain multiple bootloaders for the
machine.
</para></listitem>
<listitem><para>
<filename><replaceable>symlinks</replaceable></filename>:
<replaceable>symlinks</replaceable>:
The
<filename>deploy/images/<replaceable>machine</replaceable></filename>
<filename>deploy/images/</filename><replaceable>machine</replaceable>
folder contains a symbolic link that points to the
most recently built file for each machine.
These links might be useful for external scripts that