1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 17:39:31 +00:00

ref-manual: Updated "Images" chapter to remove listed dirs for recipes.

This list has grown substantially and it is impractical to list
the directories that contain image recipes out.  I left the
"ls" command that the use could run in order to see those
directories.  This makes the section of the manual much more
maintainable.

(From yocto-docs rev: ee129f578dfa986937b45b111e0e26b61b42c565)

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
2014-08-07 15:57:58 +03:00
committed by Richard Purdie
parent 46fb10d6cc
commit 2ef2b72b2c
+130 -134
View File
@@ -28,145 +28,141 @@
</note> </note>
<para> <para>
From within the <filename>poky</filename> Git repository, use the following command to list From within the <filename>poky</filename> Git repository, you can use
the supported images: the following command to display the list of directories within the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
that containe image recipe files:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ ls meta*/recipes*/images/*.bb $ ls meta*/recipes*/images/*.bb
</literallayout> </literallayout>
These recipes reside in the <filename>meta/recipes-core/images</filename>,
<filename>meta/recipes-extended/images</filename>,
<filename>meta/recipes-graphics/images</filename>,
<filename>meta/recipes-qt/images</filename>,
<filename>meta/recipes-rt/images</filename>,
<filename>meta/recipes-sato/images</filename>, and
<filename>meta-skeleton/recipes-multilib/images</filename> directories
within the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
Although the recipe names are somewhat explanatory, here is a list that describes them:
</para> </para>
<itemizedlist> <para>
<listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis> Following, is a list of supported recipes:
An example virtual machine that contains all the pieces required to <itemizedlist>
run builds using the build system as well as the build system itself. <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis>
You can boot and run the image using either the An example virtual machine that contains all the pieces required to
<ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink> run builds using the build system as well as the build system itself.
or <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>. You can boot and run the image using either the
For more information on this image, see the <ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink>
<ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on or <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>.
the Yocto Project website.</para></listitem> For more information on this image, see the
<listitem><para><emphasis><filename>core-image-base</filename>:</emphasis> <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on
A console-only image that fully supports the target device hardware.</para></listitem> the Yocto Project website.</para></listitem>
<listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis> <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis>
An image with support for the Open GL-based toolkit Clutter, which enables development of A console-only image that fully supports the target device hardware.</para></listitem>
rich and animated graphical user interfaces.</para></listitem> <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis>
<listitem><para><emphasis><filename>core-image-directfb</filename>:</emphasis> An image with support for the Open GL-based toolkit Clutter, which enables development of
An image that uses <filename>directfb</filename> instead of X11. rich and animated graphical user interfaces.</para></listitem>
</para></listitem> <listitem><para><emphasis><filename>core-image-directfb</filename>:</emphasis>
<listitem><para><emphasis><filename>core-image-full-cmdline</filename>:</emphasis> An image that uses <filename>directfb</filename> instead of X11.
A console-only image with more full-featured Linux system </para></listitem>
functionality installed.</para></listitem> <listitem><para><emphasis><filename>core-image-full-cmdline</filename>:</emphasis>
<listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis> A console-only image with more full-featured Linux system
An image that conforms to the Linux Standard Base (LSB) functionality installed.</para></listitem>
specification. <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis>
This image requires a distribution configuration that An image that conforms to the Linux Standard Base (LSB)
enables LSB compliance (e.g. <filename>poky-lsb</filename>). specification.
If you build <filename>core-image-lsb</filename> without that This image requires a distribution configuration that
configuration, the image will not be LSB-compliant. enables LSB compliance (e.g. <filename>poky-lsb</filename>).
</para></listitem> If you build <filename>core-image-lsb</filename> without that
<listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis> configuration, the image will not be LSB-compliant.
A <filename>core-image-lsb</filename> image that is suitable for development work </para></listitem>
using the host. <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis>
The image includes headers and libraries you can use in a host development A <filename>core-image-lsb</filename> image that is suitable for development work
environment. using the host.
This image requires a distribution configuration that The image includes headers and libraries you can use in a host development
enables LSB compliance (e.g. <filename>poky-lsb</filename>). environment.
If you build <filename>core-image-lsb-dev</filename> without that This image requires a distribution configuration that
configuration, the image will not be LSB-compliant. enables LSB compliance (e.g. <filename>poky-lsb</filename>).
</para></listitem> If you build <filename>core-image-lsb-dev</filename> without that
<listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis> configuration, the image will not be LSB-compliant.
A <filename>core-image-lsb</filename> that includes everything in </para></listitem>
meta-toolchain but also includes development headers and libraries <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis>
to form a complete standalone SDK. A <filename>core-image-lsb</filename> that includes everything in
This image requires a distribution configuration that meta-toolchain but also includes development headers and libraries
enables LSB compliance (e.g. <filename>poky-lsb</filename>). to form a complete standalone SDK.
If you build <filename>core-image-lsb-sdk</filename> without that This image requires a distribution configuration that
configuration, the image will not be LSB-compliant. enables LSB compliance (e.g. <filename>poky-lsb</filename>).
This image is suitable for development using the target.</para></listitem> If you build <filename>core-image-lsb-sdk</filename> without that
<listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis> configuration, the image will not be LSB-compliant.
A small image just capable of allowing a device to boot.</para></listitem> This image is suitable for development using the target.</para></listitem>
<listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis> <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis>
A <filename>core-image-minimal</filename> image suitable for development work A small image just capable of allowing a device to boot.</para></listitem>
using the host. <listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis>
The image includes headers and libraries you can use in a host development A <filename>core-image-minimal</filename> image suitable for development work
environment. using the host.
</para></listitem> The image includes headers and libraries you can use in a host development
<listitem><para id='images-core-image-minimal-initramfs'><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis> environment.
A <filename>core-image-minimal</filename> image that has the Minimal RAM-based </para></listitem>
Initial Root Filesystem (initramfs) as part of the kernel, <listitem><para id='images-core-image-minimal-initramfs'><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis>
which allows the system to find the first “init” program more efficiently. A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
See the Initial Root Filesystem (initramfs) as part of the kernel,
<link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link> which allows the system to find the first “init” program more efficiently.
variable for additional information helpful when working with See the
initramfs images. <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>
</para></listitem> variable for additional information helpful when working with
<listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis> initramfs images.
A <filename>core-image-minimal</filename> image that has support </para></listitem>
for the Minimal MTD Utilities, which let the user interact with the <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis>
MTD subsystem in the kernel to perform operations on flash devices. A <filename>core-image-minimal</filename> image that has support
</para></listitem> for the Minimal MTD Utilities, which let the user interact with the
<listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis> MTD subsystem in the kernel to perform operations on flash devices.
A <filename>core-image-minimal</filename> image plus a real-time test suite and </para></listitem>
tools appropriate for real-time use.</para></listitem> <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis>
<listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis> A <filename>core-image-minimal</filename> image plus a real-time test suite and
A <filename>core-image-rt</filename> image that includes everything in tools appropriate for real-time use.</para></listitem>
<filename>meta-toolchain</filename>. <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis>
The image also includes development headers and libraries to form a complete A <filename>core-image-rt</filename> image that includes everything in
stand-alone SDK and is suitable for development using the target. <filename>meta-toolchain</filename>.
</para></listitem> The image also includes development headers and libraries to form a complete
<listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis> stand-alone SDK and is suitable for development using the target.
An image with Sato support, a mobile environment and visual style that works well </para></listitem>
with mobile devices. <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis>
The image supports X11 with a Sato theme and applications such as An image with Sato support, a mobile environment and visual style that works well
a terminal, editor, file manager, media player, and so forth. with mobile devices.
</para></listitem> The image supports X11 with a Sato theme and applications such as
<listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis> a terminal, editor, file manager, media player, and so forth.
A <filename>core-image-sato</filename> image suitable for development </para></listitem>
using the host. <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis>
The image includes libraries needed to build applications on the device itself, A <filename>core-image-sato</filename> image suitable for development
testing and profiling tools, and debug symbols. using the host.
This image was formerly <filename>core-image-sdk</filename>. The image includes libraries needed to build applications on the device itself,
</para></listitem> testing and profiling tools, and debug symbols.
<listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis> This image was formerly <filename>core-image-sdk</filename>.
A <filename>core-image-sato</filename> image that includes everything in meta-toolchain. </para></listitem>
The image also includes development headers and libraries to form a complete standalone SDK <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis>
and is suitable for development using the target.</para></listitem> A <filename>core-image-sato</filename> image that includes everything in meta-toolchain.
<listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis> The image also includes development headers and libraries to form a complete standalone SDK
A "master" image designed to be used for automated runtime testing. and is suitable for development using the target.</para></listitem>
Provides a "known good" image that is deployed to a separate <listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis>
partition so that you can boot into it and use it to deploy a A "master" image designed to be used for automated runtime testing.
second image to be tested. Provides a "known good" image that is deployed to a separate
You can find more information about runtime testing in the partition so that you can boot into it and use it to deploy a
"<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" second image to be tested.
section in the Yocto Project Development Manual. You can find more information about runtime testing in the
</para></listitem> "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
<listitem><para><emphasis><filename>core-image-testmaster-initramfs</filename>:</emphasis> section in the Yocto Project Development Manual.
A RAM-based Initial Root Filesystem (initramfs) image tailored for </para></listitem>
use with the <filename>core-image-testmaster</filename> image. <listitem><para><emphasis><filename>core-image-testmaster-initramfs</filename>:</emphasis>
</para></listitem> A RAM-based Initial Root Filesystem (initramfs) image tailored for
<listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis> use with the <filename>core-image-testmaster</filename> image.
A very basic Wayland image with a terminal. </para></listitem>
This image provides the Wayland protocol libraries and the <listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis>
reference Weston compositor. A very basic Wayland image with a terminal.
For more information, see the This image provides the Wayland protocol libraries and the
"<link linkend='wayland'>Wayland</link>" section. reference Weston compositor.
</para></listitem> For more information, see the
<listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis> "<link linkend='wayland'>Wayland</link>" section.
A very basic X11 image with a terminal. </para></listitem>
</para></listitem> <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis>
<listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis> A very basic X11 image with a terminal.
An image that launches into the demo application for the embedded </para></listitem>
(not based on X11) version of Qt.</para></listitem> <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis>
</itemizedlist> An image that launches into the demo application for the embedded
(not based on X11) version of Qt.</para></listitem>
</itemizedlist>
</para>
</chapter> </chapter>
<!-- <!--
vim: expandtab tw=80 ts=4 vim: expandtab tw=80 ts=4