path: root/documentation/ref-manual/ref-images.xml
diff options
Diffstat (limited to 'documentation/ref-manual/ref-images.xml')
1 files changed, 167 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml
new file mode 100644
index 0000000..e7d76f2
--- /dev/null
+++ b/documentation/ref-manual/ref-images.xml
@@ -0,0 +1,167 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
5<chapter id='ref-images'>
6 <title>Images</title>
8 <para>
9 The OpenEmbedded build system provides several example
10 images to satisfy different needs.
11 When you issue the <filename>bitbake</filename> command you provide a “top-level” recipe
12 that essentially begins the build for the type of image you want.
13 </para>
15 <note>
16 Building an image without GNU General Public License Version 3 (GPLv3) components
17 is only supported for minimal and base images.
18 Furthermore, if you are going to build an image using non-GPLv3 components,
19 you must make the following changes in the <filename>local.conf</filename> file
20 before using the BitBake command to build the minimal or base image:
21 <literallayout class='monospaced'>
22 1. Comment out the EXTRA_IMAGE_FEATURES line
24 </literallayout>
25 </note>
27 <para>
28 From within the <filename>poky</filename> Git repository, use the following command to list
29 the supported images:
30 <literallayout class='monospaced'>
31 $ ls meta*/recipes*/images/*.bb
32 </literallayout>
33 These recipes reside in the <filename>meta/recipes-core/images</filename>,
34 <filename>meta/recipes-extended/images</filename>,
35 <filename>meta/recipes-graphics/images</filename>,
36 <filename>meta/recipes-qt/images</filename>,
37 <filename>meta/recipes-rt/images</filename>,
38 <filename>meta/recipes-sato/images</filename>, and
39 <filename>meta-skeleton/recipes-multilib/images</filename> directories
40 within the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
41 Although the recipe names are somewhat explanatory, here is a list that describes them:
42 </para>
44 <itemizedlist>
45 <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis>
46 An example virtual machine that contains all the pieces required to
47 run builds using the build system as well as the build system itself.
48 You can boot and run the image using either the
49 <ulink url=''>VMware Player</ulink>
50 or <ulink url=''>VMware Workstation</ulink>.
51 For more information on this image, see the
52 <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on
53 the Yocto Project website.</para></listitem>
54 <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis>
55 A console-only image that fully supports the target device hardware.</para></listitem>
56 <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis>
57 A small image just capable of allowing a device to boot.</para></listitem>
58 <listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis>
59 A <filename>core-image-minimal</filename> image suitable for development work
60 using the host.
61 The image includes headers and libraries you can use in a host development
62 environment.
63 </para></listitem>
64 <listitem><para id='images-core-image-minimal-initramfs'><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis>
65 A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
66 Initial Root Filesystem (initramfs) as part of the kernel,
67 which allows the system to find the first “init” program more efficiently.
68 See the
69 <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>
70 variable for additional information helpful when working with
71 initramfs images.
72 </para></listitem>
73 <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis>
74 A <filename>core-image-minimal</filename> image that has support
75 for the Minimal MTD Utilities, which let the user interact with the
76 MTD subsystem in the kernel to perform operations on flash devices.
77 </para></listitem>
78 <listitem><para><emphasis><filename>core-image-full-cmdline</filename>:</emphasis>
79 A console-only image with more full-featured Linux system
80 functionality installed.</para></listitem>
81 <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis>
82 An image that conforms to the Linux Standard Base (LSB) specification.
83 </para></listitem>
84 <listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis>
85 A "master" image designed to be used for automated runtime testing.
86 Provides a "known good" image that is deployed to a separate
87 partition so that you can boot into it and use it to deploy a
88 second image to be tested.
89 You can find more information about runtime testing in the
90 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
91 section in the Yocto Project Development Manual.
92 </para></listitem>
93 <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis>
94 A <filename>core-image-lsb</filename> image that is suitable for development work
95 using the host.
96 The image includes headers and libraries you can use in a host development
97 environment.
98 </para></listitem>
99 <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis>
100 A <filename>core-image-lsb</filename> that includes everything in meta-toolchain
101 but also includes development headers and libraries to form a complete standalone SDK.
102 This image is suitable for development using the target.</para></listitem>
103 <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis>
104 An image with support for the Open GL-based toolkit Clutter, which enables development of
105 rich and animated graphical user interfaces.</para></listitem>
106 <listitem><para><emphasis><filename>core-image-directfb</filename>:</emphasis>
107 An image that uses <filename>directfb</filename> instead of X11.
108 </para></listitem>
109 <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis>
110 A very basic X11 image with a terminal.
111 </para></listitem>
112 <listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis>
113 An image that provides the Wayland protocol libraries and the
114 reference Weston compositor.
115 For more information, see the
116 "<link linkend='wayland'>Wayland</link>" section.
117 </para></listitem>
118 <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis>
119 An image that launches into the demo application for the embedded
120 (not based on X11) version of Qt.</para></listitem>
121 <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis>
122 A <filename>core-image-minimal</filename> image plus a real-time test suite and
123 tools appropriate for real-time use.</para></listitem>
124 <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis>
125 A <filename>core-image-rt</filename> image that includes everything in
126 <filename>meta-toolchain</filename>.
127 The image also includes development headers and libraries to form a complete
128 stand-alone SDK and is suitable for development using the target.
129 </para></listitem>
130 <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis>
131 An image with Sato support, a mobile environment and visual style that works well
132 with mobile devices.
133 The image supports X11 with a Sato theme and applications such as
134 a terminal, editor, file manager, media player, and so forth.
135 </para></listitem>
136 <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis>
137 A <filename>core-image-sato</filename> image suitable for development
138 using the host.
139 The image includes libraries needed to build applications on the device itself,
140 testing and profiling tools, and debug symbols.
141 This image was formerly <filename>core-image-sdk</filename>.
142 </para></listitem>
143 <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis>
144 A <filename>core-image-sato</filename> image that includes everything in meta-toolchain.
145 The image also includes development headers and libraries to form a complete standalone SDK
146 and is suitable for development using the target.</para></listitem>
147 <listitem><para><emphasis><filename>core-image-multilib-example</filename>:</emphasis>
148 An example image that includes a <filename>lib32</filename> version
149 of Bash into an otherwise standard <filename>sato</filename> image.
150 The image assumes a "lib32" multilib has been enabled in the your
151 configuration.</para></listitem>
152 </itemizedlist>
154 <tip>
155 From the Yocto Project release 1.1 onwards, <filename>-live</filename> and
156 <filename>-directdisk</filename> images have been replaced by a "live"
157 option in <filename>IMAGE_FSTYPES</filename> that will work with any image to produce an
158 image file that can be
159 copied directly to a CD or USB device and run as is.
160 To build a live image, simply add
161 "live" to <filename>IMAGE_FSTYPES</filename> within the <filename>local.conf</filename>
162 file or wherever appropriate and then build the desired image as normal.
163 </tip>
166vim: expandtab tw=80 ts=4