diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-05-09 15:33:38 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-05-24 17:16:32 +0100 |
commit | b20454dbdfd7ae8743ee585c759e4e4447096880 (patch) | |
tree | 5084bc25fe626b3bbdba34d6cf66a59dc9d4738d | |
parent | 6f90c9687222c63eb31e6dfeedf9b72cb6373ed8 (diff) | |
download | poky-b20454dbdfd7ae8743ee585c759e4e4447096880.tar.gz |
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>
-rw-r--r-- | documentation/overview-manual/overview-manual-concepts.xml | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/documentation/overview-manual/overview-manual-concepts.xml b/documentation/overview-manual/overview-manual-concepts.xml index 3fc810d21a..80cf3ad2d2 100644 --- a/documentation/overview-manual/overview-manual-concepts.xml +++ b/documentation/overview-manual/overview-manual-concepts.xml | |||
@@ -1949,9 +1949,9 @@ | |||
1949 | <title>Images</title> | 1949 | <title>Images</title> |
1950 | 1950 | ||
1951 | <para> | 1951 | <para> |
1952 | The images produced by the OpenEmbedded build system | 1952 | The images produced by the build system are compressed forms |
1953 | are compressed forms of the | 1953 | of the root filesystem and are ready to boot on a target |
1954 | root filesystem that are ready to boot on a target device. | 1954 | device. |
1955 | You can see from the | 1955 | You can see from the |
1956 | <link linkend='general-workflow-figure'>general workflow figure</link> | 1956 | <link linkend='general-workflow-figure'>general workflow figure</link> |
1957 | that BitBake output, in part, consists of images. | 1957 | that BitBake output, in part, consists of images. |
@@ -1959,15 +1959,15 @@ | |||
1959 | <imagedata fileref="figures/images.png" align="center" width="5.5in" depth="5.5in" /> | 1959 | <imagedata fileref="figures/images.png" align="center" width="5.5in" depth="5.5in" /> |
1960 | </para> | 1960 | </para> |
1961 | 1961 | ||
1962 | <para> | 1962 | <note> |
1963 | For a list of example images that the Yocto Project provides, | 1963 | For a list of example images that the Yocto Project provides, |
1964 | see the | 1964 | see the |
1965 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" | 1965 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" |
1966 | chapter in the Yocto Project Reference Manual. | 1966 | chapter in the Yocto Project Reference Manual. |
1967 | </para> | 1967 | </note> |
1968 | 1968 | ||
1969 | <para> | 1969 | <para> |
1970 | Images are written out to the | 1970 | The build process writes images out to the |
1971 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> | 1971 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
1972 | inside the | 1972 | inside the |
1973 | <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename> | 1973 | <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename> |
@@ -1983,7 +1983,7 @@ | |||
1983 | for the current configuration. | 1983 | for the current configuration. |
1984 | <itemizedlist> | 1984 | <itemizedlist> |
1985 | <listitem><para> | 1985 | <listitem><para> |
1986 | <filename><replaceable>kernel-image</replaceable></filename>: | 1986 | <replaceable>kernel-image</replaceable>: |
1987 | A kernel binary file. | 1987 | A kernel binary file. |
1988 | The | 1988 | The |
1989 | <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></ulink> | 1989 | <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></ulink> |
@@ -1992,12 +1992,12 @@ | |||
1992 | Depending on that variable, the file could begin with | 1992 | Depending on that variable, the file could begin with |
1993 | a variety of naming strings. | 1993 | a variety of naming strings. |
1994 | The | 1994 | The |
1995 | <filename>deploy/images/<replaceable>machine</replaceable></filename> | 1995 | <filename>deploy/images/</filename><replaceable>machine</replaceable> |
1996 | directory can contain multiple image files for the | 1996 | directory can contain multiple image files for the |
1997 | machine. | 1997 | machine. |
1998 | </para></listitem> | 1998 | </para></listitem> |
1999 | <listitem><para> | 1999 | <listitem><para> |
2000 | <filename><replaceable>root-filesystem-image</replaceable></filename>: | 2000 | <replaceable>root-filesystem-image</replaceable>: |
2001 | Root filesystems for the target device (e.g. | 2001 | Root filesystems for the target device (e.g. |
2002 | <filename>*.ext3</filename> or | 2002 | <filename>*.ext3</filename> or |
2003 | <filename>*.bz2</filename> files). | 2003 | <filename>*.bz2</filename> files). |
@@ -2006,12 +2006,12 @@ | |||
2006 | variable setting determines the root filesystem image | 2006 | variable setting determines the root filesystem image |
2007 | type. | 2007 | type. |
2008 | The | 2008 | The |
2009 | <filename>deploy/images/<replaceable>machine</replaceable></filename> | 2009 | <filename>deploy/images/</filename><replaceable>machine</replaceable> |
2010 | directory can contain multiple root filesystems for the | 2010 | directory can contain multiple root filesystems for the |
2011 | machine. | 2011 | machine. |
2012 | </para></listitem> | 2012 | </para></listitem> |
2013 | <listitem><para> | 2013 | <listitem><para> |
2014 | <filename><replaceable>kernel-modules</replaceable></filename>: | 2014 | <replaceable>kernel-modules</replaceable>: |
2015 | Tarballs that contain all the modules built for the | 2015 | Tarballs that contain all the modules built for the |
2016 | kernel. | 2016 | kernel. |
2017 | Kernel module tarballs exist for legacy purposes and | 2017 | Kernel module tarballs exist for legacy purposes and |
@@ -2019,22 +2019,22 @@ | |||
2019 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></ulink> | 2019 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></ulink> |
2020 | variable to "0". | 2020 | variable to "0". |
2021 | The | 2021 | The |
2022 | <filename>deploy/images/<replaceable>machine</replaceable></filename> | 2022 | <filename>deploy/images/</filename><replaceable>machine</replaceable> |
2023 | directory can contain multiple kernel module tarballs | 2023 | directory can contain multiple kernel module tarballs |
2024 | for the machine. | 2024 | for the machine. |
2025 | </para></listitem> | 2025 | </para></listitem> |
2026 | <listitem><para> | 2026 | <listitem><para> |
2027 | <filename><replaceable>bootloaders</replaceable></filename>: | 2027 | <replaceable>bootloaders</replaceable>: |
2028 | Bootloaders supporting the image, if applicable to the | 2028 | If applicable to the target machine, bootloaders |
2029 | target machine. | 2029 | supporting the image. |
2030 | The <filename>deploy/images/<replaceable>machine</replaceable></filename> | 2030 | The <filename>deploy/images/</filename><replaceable>machine</replaceable> |
2031 | directory can contain multiple bootloaders for the | 2031 | directory can contain multiple bootloaders for the |
2032 | machine. | 2032 | machine. |
2033 | </para></listitem> | 2033 | </para></listitem> |
2034 | <listitem><para> | 2034 | <listitem><para> |
2035 | <filename><replaceable>symlinks</replaceable></filename>: | 2035 | <replaceable>symlinks</replaceable>: |
2036 | The | 2036 | The |
2037 | <filename>deploy/images/<replaceable>machine</replaceable></filename> | 2037 | <filename>deploy/images/</filename><replaceable>machine</replaceable> |
2038 | folder contains a symbolic link that points to the | 2038 | folder contains a symbolic link that points to the |
2039 | most recently built file for each machine. | 2039 | most recently built file for each machine. |
2040 | These links might be useful for external scripts that | 2040 | These links might be useful for external scripts that |