summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-03-28 06:51:59 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-04 14:13:36 +0100
commitd4366144248ffa9ee50d717143b1e87a8a3aa437 (patch)
tree1f234f81d5c5641dc97b328a0732a530e586fcd7 /documentation/ref-manual
parenta8532b0f84f957df679c7923c337f09a418b6263 (diff)
downloadpoky-d4366144248ffa9ee50d717143b1e87a8a3aa437.tar.gz
ref-manual: Updates to the "Images" chapter.
Made sure the list of shipped (supported) images was up-to-date. Had to add a couple. Also, some extra edits to support the new list. (From yocto-docs rev: db5bc1dd0079d0d8db67653a9878205d4b89258f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-images.xml75
1 files changed, 46 insertions, 29 deletions
diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml
index 0a827ca235..e08fd19adf 100644
--- a/documentation/ref-manual/ref-images.xml
+++ b/documentation/ref-manual/ref-images.xml
@@ -31,13 +31,25 @@
31 </literallayout> 31 </literallayout>
32 These recipes reside in the <filename>meta/recipes-core/images</filename>, 32 These recipes reside in the <filename>meta/recipes-core/images</filename>,
33 <filename>meta/recipes-extended/images</filename>, 33 <filename>meta/recipes-extended/images</filename>,
34 <filename>meta/recipes-graphics/images</filename>, and 34 <filename>meta/recipes-graphics/images</filename>,
35 <filename>meta/recipes-sato/images</filename> directories 35 <filename>meta/recipes-qt/images</filename>,
36 within the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 36 <filename>meta/recipes-rt/images</filename>,
37 <filename>meta/recipes-sato/images</filename>, and
38 <filename>meta-skeleton/recipes-multilib/images</filename> directories
39 within the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
37 Although the recipe names are somewhat explanatory, here is a list that describes them: 40 Although the recipe names are somewhat explanatory, here is a list that describes them:
38 </para> 41 </para>
39 42
40 <itemizedlist> 43 <itemizedlist>
44 <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis>
45 An example virtual machine that contains all the pieces required to
46 run builds using the build system as well as the build system itself.
47 You can boot and run the image using either the
48 <ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink>
49 or <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>.
50 For more information on this image, see the
51 <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on
52 the Yocto Project website.</para></listitem>
41 <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis> 53 <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis>
42 A console-only image that fully supports the target device hardware.</para></listitem> 54 A console-only image that fully supports the target device hardware.</para></listitem>
43 <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis> 55 <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis>
@@ -58,14 +70,12 @@
58 for the Minimal MTD Utilities, which let the user interact with the 70 for the Minimal MTD Utilities, which let the user interact with the
59 MTD subsystem in the kernel to perform operations on flash devices. 71 MTD subsystem in the kernel to perform operations on flash devices.
60 </para></listitem> 72 </para></listitem>
61 <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis>
62 A very basic X11 image with a terminal.
63 </para></listitem>
64 <listitem><para><emphasis><filename>core-image-basic</filename>:</emphasis> 73 <listitem><para><emphasis><filename>core-image-basic</filename>:</emphasis>
65 A console-only image with more full-featured Linux system 74 A console-only image with more full-featured Linux system
66 functionality installed.</para></listitem> 75 functionality installed.</para></listitem>
67 <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis> 76 <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis>
68 An image that conforms to the Linux Standard Base (LSB) specification.</para></listitem> 77 An image that conforms to the Linux Standard Base (LSB) specification.
78 </para></listitem>
69 <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis> 79 <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis>
70 A <filename>core-image-lsb</filename> image that is suitable for development work 80 A <filename>core-image-lsb</filename> image that is suitable for development work
71 using the host. 81 using the host.
@@ -79,41 +89,48 @@
79 <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis> 89 <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis>
80 An image with support for the Open GL-based toolkit Clutter, which enables development of 90 An image with support for the Open GL-based toolkit Clutter, which enables development of
81 rich and animated graphical user interfaces.</para></listitem> 91 rich and animated graphical user interfaces.</para></listitem>
92 <listitem><para><emphasis><filename>core-image-gtk-directfb</filename>:</emphasis>
93 An image that uses <filename>gtk+</filename> over <filename>directfb</filename>
94 instead of X11.
95 In order to build, this image requires specific distro configuration that enables
96 <filename>gtk</filename> over <filename>directfb</filename>.</para></listitem>
97 <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis>
98 A very basic X11 image with a terminal.
99 </para></listitem>
100 <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis>
101 An image that launches into the demo application for the embedded
102 (not based on X11) version of Qt.</para></listitem>
103 <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis>
104 A <filename>core-image-minimal</filename> image plus a real-time test suite and
105 tools appropriate for real-time use.</para></listitem>
106 <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis>
107 A <filename>core-image-rt</filename> image that includes everything in
108 <filename>meta-toolchain</filename>.
109 The image also includes development headers and libraries to form a complete
110 stand-alone SDK and is suitable for development using the target.
111 </para></listitem>
82 <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis> 112 <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis>
83 An image with Sato support, a mobile environment and visual style that works well 113 An image with Sato support, a mobile environment and visual style that works well
84 with mobile devices. 114 with mobile devices.
85 The image supports X11 with a Sato theme and applications such as 115 The image supports X11 with a Sato theme and applications such as
86 a terminal, editor, file manager, media player, and so forth.</para></listitem> 116 a terminal, editor, file manager, media player, and so forth.
117 </para></listitem>
87 <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis> 118 <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis>
88 A <filename>core-image-sato</filename> image suitable for development 119 A <filename>core-image-sato</filename> image suitable for development
89 using the host. 120 using the host.
90 The image includes libraries needed to build applications on the device itself, 121 The image includes libraries needed to build applications on the device itself,
91 testing and profiling tools, and debug symbols. 122 testing and profiling tools, and debug symbols.
92 This image was formerly <filename>core-image-sdk</filename>.</para></listitem> 123 This image was formerly <filename>core-image-sdk</filename>.
124 </para></listitem>
93 <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis> 125 <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis>
94 A <filename>core-image-sato</filename> image that includes everything in meta-toolchain. 126 A <filename>core-image-sato</filename> image that includes everything in meta-toolchain.
95 The image also includes development headers and libraries to form a complete standalone SDK 127 The image also includes development headers and libraries to form a complete standalone SDK
96 and is suitable for development using the target.</para></listitem> 128 and is suitable for development using the target.</para></listitem>
97 <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis> 129 <listitem><para><emphasis><filename>core-image-multilib-example</filename>:</emphasis>
98 A <filename>core-image-minimal</filename> image plus a real-time test suite and 130 An example image that includes a <filename>lib32</filename> version
99 tools appropriate for real-time use.</para></listitem> 131 of Bash into an otherwise standard <filename>sato</filename> image.
100 <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis> 132 The image assumes a "lib32" multilib has been enabled in the your
101 A <filename>core-image-rt</filename> image that includes everything in 133 configuration.</para></listitem>
102 <filename>meta-toolchain</filename>.
103 The image also includes development headers and libraries to form a complete
104 stand-alone SDK and is suitable for development using the target.</para></listitem>
105 <listitem><para><emphasis><filename>core-image-gtk-directfb</filename>:</emphasis>
106 An image that uses <filename>gtk+</filename> over <filename>directfb</filename>
107 instead of X11.
108 In order to build, this image requires specific distro configuration that enables
109 <filename>gtk</filename> over <filename>directfb</filename>.</para></listitem>
110 <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis>
111 An image you can boot and run using either the
112 <ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink>
113 or <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>.
114 For more information on this image, see the
115 <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on
116 the Yocto Project website.</para></listitem>
117 </itemizedlist> 134 </itemizedlist>
118 135
119 <tip> 136 <tip>