summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-08-07 15:57:58 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-08-12 13:50:31 +0100
commit2ef2b72b2cd92a3a101e4ae50ee89642335ea7a9 (patch)
tree05a1db4a4bce6e42ae3c1e84eea79900db42c6e2
parent46fb10d6cc00aa2ae90794e7f7d443d063a6ba43 (diff)
downloadopenembedded-core-contrib-2ef2b72b2cd92a3a101e4ae50ee89642335ea7a9.tar.gz
openembedded-core-contrib-2ef2b72b2cd92a3a101e4ae50ee89642335ea7a9.tar.bz2
openembedded-core-contrib-2ef2b72b2cd92a3a101e4ae50ee89642335ea7a9.zip
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>
-rw-r--r--documentation/ref-manual/ref-images.xml264
1 files changed, 130 insertions, 134 deletions
diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml
index 9c80c55a37..503595c364 100644
--- a/documentation/ref-manual/ref-images.xml
+++ b/documentation/ref-manual/ref-images.xml
@@ -28,145 +28,141 @@
</note>
<para>
- From within the <filename>poky</filename> Git repository, use the following command to list
- the supported images:
+ From within the <filename>poky</filename> Git repository, you can use
+ 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'>
$ ls meta*/recipes*/images/*.bb
</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>
- <itemizedlist>
- <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis>
- An example virtual machine that contains all the pieces required to
- run builds using the build system as well as the build system itself.
- You can boot and run the image using either the
- <ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink>
- or <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>.
- For more information on this image, see the
- <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on
- the Yocto Project website.</para></listitem>
- <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis>
- A console-only image that fully supports the target device hardware.</para></listitem>
- <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis>
- An image with support for the Open GL-based toolkit Clutter, which enables development of
- rich and animated graphical user interfaces.</para></listitem>
- <listitem><para><emphasis><filename>core-image-directfb</filename>:</emphasis>
- An image that uses <filename>directfb</filename> instead of X11.
- </para></listitem>
- <listitem><para><emphasis><filename>core-image-full-cmdline</filename>:</emphasis>
- A console-only image with more full-featured Linux system
- functionality installed.</para></listitem>
- <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis>
- An image that conforms to the Linux Standard Base (LSB)
- specification.
- This image requires a distribution configuration that
- enables LSB compliance (e.g. <filename>poky-lsb</filename>).
- If you build <filename>core-image-lsb</filename> without that
- configuration, the image will not be LSB-compliant.
- </para></listitem>
- <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis>
- A <filename>core-image-lsb</filename> image that is suitable for development work
- using the host.
- The image includes headers and libraries you can use in a host development
- environment.
- This image requires a distribution configuration that
- enables LSB compliance (e.g. <filename>poky-lsb</filename>).
- If you build <filename>core-image-lsb-dev</filename> without that
- configuration, the image will not be LSB-compliant.
- </para></listitem>
- <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis>
- A <filename>core-image-lsb</filename> that includes everything in
- meta-toolchain but also includes development headers and libraries
- to form a complete standalone SDK.
- This image requires a distribution configuration that
- enables LSB compliance (e.g. <filename>poky-lsb</filename>).
- If you build <filename>core-image-lsb-sdk</filename> without that
- configuration, the image will not be LSB-compliant.
- This image is suitable for development using the target.</para></listitem>
- <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis>
- A small image just capable of allowing a device to boot.</para></listitem>
- <listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis>
- A <filename>core-image-minimal</filename> image suitable for development work
- using the host.
- The image includes headers and libraries you can use in a host development
- environment.
- </para></listitem>
- <listitem><para id='images-core-image-minimal-initramfs'><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis>
- A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
- Initial Root Filesystem (initramfs) as part of the kernel,
- which allows the system to find the first “init” program more efficiently.
- See the
- <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>
- variable for additional information helpful when working with
- initramfs images.
- </para></listitem>
- <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis>
- A <filename>core-image-minimal</filename> image that has support
- for the Minimal MTD Utilities, which let the user interact with the
- MTD subsystem in the kernel to perform operations on flash devices.
- </para></listitem>
- <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis>
- A <filename>core-image-minimal</filename> image plus a real-time test suite and
- tools appropriate for real-time use.</para></listitem>
- <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis>
- A <filename>core-image-rt</filename> image that includes everything in
- <filename>meta-toolchain</filename>.
- The image also includes development headers and libraries to form a complete
- stand-alone SDK and is suitable for development using the target.
- </para></listitem>
- <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis>
- An image with Sato support, a mobile environment and visual style that works well
- with mobile devices.
- The image supports X11 with a Sato theme and applications such as
- a terminal, editor, file manager, media player, and so forth.
- </para></listitem>
- <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis>
- A <filename>core-image-sato</filename> image suitable for development
- using the host.
- The image includes libraries needed to build applications on the device itself,
- testing and profiling tools, and debug symbols.
- This image was formerly <filename>core-image-sdk</filename>.
- </para></listitem>
- <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis>
- A <filename>core-image-sato</filename> image that includes everything in meta-toolchain.
- The image also includes development headers and libraries to form a complete standalone SDK
- and is suitable for development using the target.</para></listitem>
- <listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis>
- A "master" image designed to be used for automated runtime testing.
- Provides a "known good" image that is deployed to a separate
- partition so that you can boot into it and use it to deploy a
- second image to be tested.
- You can find more information about runtime testing in the
- "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
- section in the Yocto Project Development Manual.
- </para></listitem>
- <listitem><para><emphasis><filename>core-image-testmaster-initramfs</filename>:</emphasis>
- A RAM-based Initial Root Filesystem (initramfs) image tailored for
- use with the <filename>core-image-testmaster</filename> image.
- </para></listitem>
- <listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis>
- A very basic Wayland image with a terminal.
- This image provides the Wayland protocol libraries and the
- reference Weston compositor.
- For more information, see the
- "<link linkend='wayland'>Wayland</link>" section.
- </para></listitem>
- <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis>
- A very basic X11 image with a terminal.
- </para></listitem>
- <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis>
- An image that launches into the demo application for the embedded
- (not based on X11) version of Qt.</para></listitem>
- </itemizedlist>
+ <para>
+ Following, is a list of supported recipes:
+ <itemizedlist>
+ <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis>
+ An example virtual machine that contains all the pieces required to
+ run builds using the build system as well as the build system itself.
+ You can boot and run the image using either the
+ <ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink>
+ or <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>.
+ For more information on this image, see the
+ <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on
+ the Yocto Project website.</para></listitem>
+ <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis>
+ A console-only image that fully supports the target device hardware.</para></listitem>
+ <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis>
+ An image with support for the Open GL-based toolkit Clutter, which enables development of
+ rich and animated graphical user interfaces.</para></listitem>
+ <listitem><para><emphasis><filename>core-image-directfb</filename>:</emphasis>
+ An image that uses <filename>directfb</filename> instead of X11.
+ </para></listitem>
+ <listitem><para><emphasis><filename>core-image-full-cmdline</filename>:</emphasis>
+ A console-only image with more full-featured Linux system
+ functionality installed.</para></listitem>
+ <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis>
+ An image that conforms to the Linux Standard Base (LSB)
+ specification.
+ This image requires a distribution configuration that
+ enables LSB compliance (e.g. <filename>poky-lsb</filename>).
+ If you build <filename>core-image-lsb</filename> without that
+ configuration, the image will not be LSB-compliant.
+ </para></listitem>
+ <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis>
+ A <filename>core-image-lsb</filename> image that is suitable for development work
+ using the host.
+ The image includes headers and libraries you can use in a host development
+ environment.
+ This image requires a distribution configuration that
+ enables LSB compliance (e.g. <filename>poky-lsb</filename>).
+ If you build <filename>core-image-lsb-dev</filename> without that
+ configuration, the image will not be LSB-compliant.
+ </para></listitem>
+ <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis>
+ A <filename>core-image-lsb</filename> that includes everything in
+ meta-toolchain but also includes development headers and libraries
+ to form a complete standalone SDK.
+ This image requires a distribution configuration that
+ enables LSB compliance (e.g. <filename>poky-lsb</filename>).
+ If you build <filename>core-image-lsb-sdk</filename> without that
+ configuration, the image will not be LSB-compliant.
+ This image is suitable for development using the target.</para></listitem>
+ <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis>
+ A small image just capable of allowing a device to boot.</para></listitem>
+ <listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis>
+ A <filename>core-image-minimal</filename> image suitable for development work
+ using the host.
+ The image includes headers and libraries you can use in a host development
+ environment.
+ </para></listitem>
+ <listitem><para id='images-core-image-minimal-initramfs'><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis>
+ A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
+ Initial Root Filesystem (initramfs) as part of the kernel,
+ which allows the system to find the first “init” program more efficiently.
+ See the
+ <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>
+ variable for additional information helpful when working with
+ initramfs images.
+ </para></listitem>
+ <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis>
+ A <filename>core-image-minimal</filename> image that has support
+ for the Minimal MTD Utilities, which let the user interact with the
+ MTD subsystem in the kernel to perform operations on flash devices.
+ </para></listitem>
+ <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis>
+ A <filename>core-image-minimal</filename> image plus a real-time test suite and
+ tools appropriate for real-time use.</para></listitem>
+ <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis>
+ A <filename>core-image-rt</filename> image that includes everything in
+ <filename>meta-toolchain</filename>.
+ The image also includes development headers and libraries to form a complete
+ stand-alone SDK and is suitable for development using the target.
+ </para></listitem>
+ <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis>
+ An image with Sato support, a mobile environment and visual style that works well
+ with mobile devices.
+ The image supports X11 with a Sato theme and applications such as
+ a terminal, editor, file manager, media player, and so forth.
+ </para></listitem>
+ <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis>
+ A <filename>core-image-sato</filename> image suitable for development
+ using the host.
+ The image includes libraries needed to build applications on the device itself,
+ testing and profiling tools, and debug symbols.
+ This image was formerly <filename>core-image-sdk</filename>.
+ </para></listitem>
+ <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis>
+ A <filename>core-image-sato</filename> image that includes everything in meta-toolchain.
+ The image also includes development headers and libraries to form a complete standalone SDK
+ and is suitable for development using the target.</para></listitem>
+ <listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis>
+ A "master" image designed to be used for automated runtime testing.
+ Provides a "known good" image that is deployed to a separate
+ partition so that you can boot into it and use it to deploy a
+ second image to be tested.
+ You can find more information about runtime testing in the
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
+ section in the Yocto Project Development Manual.
+ </para></listitem>
+ <listitem><para><emphasis><filename>core-image-testmaster-initramfs</filename>:</emphasis>
+ A RAM-based Initial Root Filesystem (initramfs) image tailored for
+ use with the <filename>core-image-testmaster</filename> image.
+ </para></listitem>
+ <listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis>
+ A very basic Wayland image with a terminal.
+ This image provides the Wayland protocol libraries and the
+ reference Weston compositor.
+ For more information, see the
+ "<link linkend='wayland'>Wayland</link>" section.
+ </para></listitem>
+ <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis>
+ A very basic X11 image with a terminal.
+ </para></listitem>
+ <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis>
+ An image that launches into the demo application for the embedded
+ (not based on X11) version of Qt.</para></listitem>
+ </itemizedlist>
+ </para>
</chapter>
<!--
vim: expandtab tw=80 ts=4