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.xml132
1 files changed, 132 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml
new file mode 100644
index 0000000000..0a827ca235
--- /dev/null
+++ b/documentation/ref-manual/ref-images.xml
@@ -0,0 +1,132 @@
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 process supports several types of images to satisfy different needs.
10 When you issue the <filename>bitbake</filename> command you provide a “top-level” recipe
11 that essentially begins the build for the type of image you want.
12 </para>
13
14 <note>
15 Building an image without GNU General Public License Version 3 (GPLv3) components
16 is only supported for minimal and base images.
17 Furthermore, if you are going to build an image using non-GPLv3 components,
18 you must make the following changes in the <filename>local.conf</filename> file
19 before using the BitBake command to build the minimal or base image:
20 <literallayout class='monospaced'>
21 1. Comment out the EXTRA_IMAGE_FEATURES line
22 2. Set INCOMPATIBLE_LICENSE = "GPLv3"
23 </literallayout>
24 </note>
25
26 <para>
27 From within the <filename>poky</filename> Git repository, use the following command to list
28 the supported images:
29 <literallayout class='monospaced'>
30 $ ls meta*/recipes*/images/*.bb
31 </literallayout>
32 These recipes reside in the <filename>meta/recipes-core/images</filename>,
33 <filename>meta/recipes-extended/images</filename>,
34 <filename>meta/recipes-graphics/images</filename>, and
35 <filename>meta/recipes-sato/images</filename> directories
36 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:
38 </para>
39
40 <itemizedlist>
41 <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis>
42 A console-only image that fully supports the target device hardware.</para></listitem>
43 <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis>
44 A small image just capable of allowing a device to boot.</para></listitem>
45 <listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis>
46 A <filename>core-image-minimal</filename> image suitable for development work
47 using the host.
48 The image includes headers and libraries you can use in a host development
49 environment.
50 </para></listitem>
51 <listitem><para><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis>
52 A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
53 Initial Root Filesystem (<filename>initramfs</filename>) as part of the kernel,
54 which allows the system to find the first “init” program more efficiently.
55 </para></listitem>
56 <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis>
57 A <filename>core-image-minimal</filename> image that has support
58 for the Minimal MTD Utilities, which let the user interact with the
59 MTD subsystem in the kernel to perform operations on flash devices.
60 </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>
65 A console-only image with more full-featured Linux system
66 functionality installed.</para></listitem>
67 <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis>
68 An image that conforms to the Linux Standard Base (LSB) specification.</para></listitem>
69 <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis>
70 A <filename>core-image-lsb</filename> image that is suitable for development work
71 using the host.
72 The image includes headers and libraries you can use in a host development
73 environment.
74 </para></listitem>
75 <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis>
76 A <filename>core-image-lsb</filename> that includes everything in meta-toolchain
77 but also includes development headers and libraries to form a complete standalone SDK.
78 This image is suitable for development using the target.</para></listitem>
79 <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
81 rich and animated graphical user interfaces.</para></listitem>
82 <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis>
83 An image with Sato support, a mobile environment and visual style that works well
84 with mobile devices.
85 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>
87 <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis>
88 A <filename>core-image-sato</filename> image suitable for development
89 using the host.
90 The image includes libraries needed to build applications on the device itself,
91 testing and profiling tools, and debug symbols.
92 This image was formerly <filename>core-image-sdk</filename>.</para></listitem>
93 <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis>
94 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
96 and is suitable for development using the target.</para></listitem>
97 <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis>
98 A <filename>core-image-minimal</filename> image plus a real-time test suite and
99 tools appropriate for real-time use.</para></listitem>
100 <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis>
101 A <filename>core-image-rt</filename> image that includes everything in
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>
118
119 <tip>
120 From the Yocto Project release 1.1 onwards, <filename>-live</filename> and
121 <filename>-directdisk</filename> images have been replaced by a "live"
122 option in <filename>IMAGE_FSTYPES</filename> that will work with any image to produce an
123 image file that can be
124 copied directly to a CD or USB device and run as is.
125 To build a live image, simply add
126 "live" to <filename>IMAGE_FSTYPES</filename> within the <filename>local.conf</filename>
127 file or wherever appropriate and then build the desired image as normal.
128 </tip>
129</chapter>
130<!--
131vim: expandtab tw=80 ts=4
132-->
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-14 11:26:52 +0000