summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-images.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-images.xml')
-rw-r--r--documentation/ref-manual/ref-images.xml166
1 files changed, 166 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..7727e0a
--- /dev/null
+++ b/documentation/ref-manual/ref-images.xml
@@ -0,0 +1,166 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='ref-images'>
6 <title>Images</title>
7
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>
14
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
23 2. Set INCOMPATIBLE_LICENSE = "GPLv3"
24 </literallayout>
25 </note>
26
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>
43
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='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink>
50 or <ulink url='http://www.vmware.com/products/workstation/overview.html'>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)
83 specification.
84 This image requires a distribution configuration that
85 enables LSB compliance (e.g. <filename>poky-lsb</filename>).
86 If you build <filename>core-image-lsb</filename> without that
87 configuration, the image will not be LSB-compliant.
88 </para></listitem>
89 <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis>
90 A <filename>core-image-lsb</filename> image that is suitable for development work
91 using the host.
92 The image includes headers and libraries you can use in a host development
93 environment.
94 This image requires a distribution configuration that
95 enables LSB compliance (e.g. <filename>poky-lsb</filename>).
96 If you build <filename>core-image-lsb-dev</filename> without that
97 configuration, the image will not be LSB-compliant.
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
101 meta-toolchain but also includes development headers and libraries
102 to form a complete standalone SDK.
103 This image requires a distribution configuration that
104 enables LSB compliance (e.g. <filename>poky-lsb</filename>).
105 If you build <filename>core-image-lsb-sdk</filename> without that
106 configuration, the image will not be LSB-compliant.
107 This image is suitable for development using the target.</para></listitem>
108 <listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis>
109 A "master" image designed to be used for automated runtime testing.
110 Provides a "known good" image that is deployed to a separate
111 partition so that you can boot into it and use it to deploy a
112 second image to be tested.
113 You can find more information about runtime testing in the
114 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
115 section in the Yocto Project Development Manual.
116 </para></listitem>
117 <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis>
118 An image with support for the Open GL-based toolkit Clutter, which enables development of
119 rich and animated graphical user interfaces.</para></listitem>
120 <listitem><para><emphasis><filename>core-image-directfb</filename>:</emphasis>
121 An image that uses <filename>directfb</filename> instead of X11.
122 </para></listitem>
123 <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis>
124 A very basic X11 image with a terminal.
125 </para></listitem>
126 <listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis>
127 A very basic Wayland image with a terminal.
128 This image provides the Wayland protocol libraries and the
129 reference Weston compositor.
130 For more information, see the
131 "<link linkend='wayland'>Wayland</link>" section.
132 </para></listitem>
133 <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis>
134 An image that launches into the demo application for the embedded
135 (not based on X11) version of Qt.</para></listitem>
136 <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis>
137 A <filename>core-image-minimal</filename> image plus a real-time test suite and
138 tools appropriate for real-time use.</para></listitem>
139 <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis>
140 A <filename>core-image-rt</filename> image that includes everything in
141 <filename>meta-toolchain</filename>.
142 The image also includes development headers and libraries to form a complete
143 stand-alone SDK and is suitable for development using the target.
144 </para></listitem>
145 <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis>
146 An image with Sato support, a mobile environment and visual style that works well
147 with mobile devices.
148 The image supports X11 with a Sato theme and applications such as
149 a terminal, editor, file manager, media player, and so forth.
150 </para></listitem>
151 <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis>
152 A <filename>core-image-sato</filename> image suitable for development
153 using the host.
154 The image includes libraries needed to build applications on the device itself,
155 testing and profiling tools, and debug symbols.
156 This image was formerly <filename>core-image-sdk</filename>.
157 </para></listitem>
158 <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis>
159 A <filename>core-image-sato</filename> image that includes everything in meta-toolchain.
160 The image also includes development headers and libraries to form a complete standalone SDK
161 and is suitable for development using the target.</para></listitem>
162 </itemizedlist>
163</chapter>
164<!--
165vim: expandtab tw=80 ts=4
166-->
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-05-13 03:42:59 +0000