summaryrefslogtreecommitdiffstats
path: root/documentation
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 /documentation
parent46fb10d6cc00aa2ae90794e7f7d443d063a6ba43 (diff)
downloadpoky-2ef2b72b2cd92a3a101e4ae50ee89642335ea7a9.tar.gz
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>
Diffstat (limited to 'documentation')
-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 @@
28 </note> 28 </note>
29 29
30 <para> 30 <para>
31 From within the <filename>poky</filename> Git repository, use the following command to list 31 From within the <filename>poky</filename> Git repository, you can use
32 the supported images: 32 the following command to display the list of directories within the
33 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
34 that containe image recipe files:
33 <literallayout class='monospaced'> 35 <literallayout class='monospaced'>
34 $ ls meta*/recipes*/images/*.bb 36 $ ls meta*/recipes*/images/*.bb
35 </literallayout> 37 </literallayout>
36 These recipes reside in the <filename>meta/recipes-core/images</filename>,
37 <filename>meta/recipes-extended/images</filename>,
38 <filename>meta/recipes-graphics/images</filename>,
39 <filename>meta/recipes-qt/images</filename>,
40 <filename>meta/recipes-rt/images</filename>,
41 <filename>meta/recipes-sato/images</filename>, and
42 <filename>meta-skeleton/recipes-multilib/images</filename> directories
43 within the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
44 Although the recipe names are somewhat explanatory, here is a list that describes them:
45 </para> 38 </para>
46 39
47 <itemizedlist> 40 <para>
48 <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis> 41 Following, is a list of supported recipes:
49 An example virtual machine that contains all the pieces required to 42 <itemizedlist>
50 run builds using the build system as well as the build system itself. 43 <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis>
51 You can boot and run the image using either the 44 An example virtual machine that contains all the pieces required to
52 <ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink> 45 run builds using the build system as well as the build system itself.
53 or <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>. 46 You can boot and run the image using either the
54 For more information on this image, see the 47 <ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink>
55 <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on 48 or <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>.
56 the Yocto Project website.</para></listitem> 49 For more information on this image, see the
57 <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis> 50 <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on
58 A console-only image that fully supports the target device hardware.</para></listitem> 51 the Yocto Project website.</para></listitem>
59 <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis> 52 <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis>
60 An image with support for the Open GL-based toolkit Clutter, which enables development of 53 A console-only image that fully supports the target device hardware.</para></listitem>
61 rich and animated graphical user interfaces.</para></listitem> 54 <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis>
62 <listitem><para><emphasis><filename>core-image-directfb</filename>:</emphasis> 55 An image with support for the Open GL-based toolkit Clutter, which enables development of
63 An image that uses <filename>directfb</filename> instead of X11. 56 rich and animated graphical user interfaces.</para></listitem>
64 </para></listitem> 57 <listitem><para><emphasis><filename>core-image-directfb</filename>:</emphasis>
65 <listitem><para><emphasis><filename>core-image-full-cmdline</filename>:</emphasis> 58 An image that uses <filename>directfb</filename> instead of X11.
66 A console-only image with more full-featured Linux system 59 </para></listitem>
67 functionality installed.</para></listitem> 60 <listitem><para><emphasis><filename>core-image-full-cmdline</filename>:</emphasis>
68 <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis> 61 A console-only image with more full-featured Linux system
69 An image that conforms to the Linux Standard Base (LSB) 62 functionality installed.</para></listitem>
70 specification. 63 <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis>
71 This image requires a distribution configuration that 64 An image that conforms to the Linux Standard Base (LSB)
72 enables LSB compliance (e.g. <filename>poky-lsb</filename>). 65 specification.
73 If you build <filename>core-image-lsb</filename> without that 66 This image requires a distribution configuration that
74 configuration, the image will not be LSB-compliant. 67 enables LSB compliance (e.g. <filename>poky-lsb</filename>).
75 </para></listitem> 68 If you build <filename>core-image-lsb</filename> without that
76 <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis> 69 configuration, the image will not be LSB-compliant.
77 A <filename>core-image-lsb</filename> image that is suitable for development work 70 </para></listitem>
78 using the host. 71 <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis>
79 The image includes headers and libraries you can use in a host development 72 A <filename>core-image-lsb</filename> image that is suitable for development work
80 environment. 73 using the host.
81 This image requires a distribution configuration that 74 The image includes headers and libraries you can use in a host development
82 enables LSB compliance (e.g. <filename>poky-lsb</filename>). 75 environment.
83 If you build <filename>core-image-lsb-dev</filename> without that 76 This image requires a distribution configuration that
84 configuration, the image will not be LSB-compliant. 77 enables LSB compliance (e.g. <filename>poky-lsb</filename>).
85 </para></listitem> 78 If you build <filename>core-image-lsb-dev</filename> without that
86 <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis> 79 configuration, the image will not be LSB-compliant.
87 A <filename>core-image-lsb</filename> that includes everything in 80 </para></listitem>
88 meta-toolchain but also includes development headers and libraries 81 <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis>
89 to form a complete standalone SDK. 82 A <filename>core-image-lsb</filename> that includes everything in
90 This image requires a distribution configuration that 83 meta-toolchain but also includes development headers and libraries
91 enables LSB compliance (e.g. <filename>poky-lsb</filename>). 84 to form a complete standalone SDK.
92 If you build <filename>core-image-lsb-sdk</filename> without that 85 This image requires a distribution configuration that
93 configuration, the image will not be LSB-compliant. 86 enables LSB compliance (e.g. <filename>poky-lsb</filename>).
94 This image is suitable for development using the target.</para></listitem> 87 If you build <filename>core-image-lsb-sdk</filename> without that
95 <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis> 88 configuration, the image will not be LSB-compliant.
96 A small image just capable of allowing a device to boot.</para></listitem> 89 This image is suitable for development using the target.</para></listitem>
97 <listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis> 90 <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis>
98 A <filename>core-image-minimal</filename> image suitable for development work 91 A small image just capable of allowing a device to boot.</para></listitem>
99 using the host. 92 <listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis>
100 The image includes headers and libraries you can use in a host development 93 A <filename>core-image-minimal</filename> image suitable for development work
101 environment. 94 using the host.
102 </para></listitem> 95 The image includes headers and libraries you can use in a host development
103 <listitem><para id='images-core-image-minimal-initramfs'><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis> 96 environment.
104 A <filename>core-image-minimal</filename> image that has the Minimal RAM-based 97 </para></listitem>
105 Initial Root Filesystem (initramfs) as part of the kernel, 98 <listitem><para id='images-core-image-minimal-initramfs'><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis>
106 which allows the system to find the first “init” program more efficiently. 99 A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
107 See the 100 Initial Root Filesystem (initramfs) as part of the kernel,
108 <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link> 101 which allows the system to find the first “init” program more efficiently.
109 variable for additional information helpful when working with 102 See the
110 initramfs images. 103 <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>
111 </para></listitem> 104 variable for additional information helpful when working with
112 <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis> 105 initramfs images.
113 A <filename>core-image-minimal</filename> image that has support 106 </para></listitem>
114 for the Minimal MTD Utilities, which let the user interact with the 107 <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis>
115 MTD subsystem in the kernel to perform operations on flash devices. 108 A <filename>core-image-minimal</filename> image that has support
116 </para></listitem> 109 for the Minimal MTD Utilities, which let the user interact with the
117 <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis> 110 MTD subsystem in the kernel to perform operations on flash devices.
118 A <filename>core-image-minimal</filename> image plus a real-time test suite and 111 </para></listitem>
119 tools appropriate for real-time use.</para></listitem> 112 <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis>
120 <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis> 113 A <filename>core-image-minimal</filename> image plus a real-time test suite and
121 A <filename>core-image-rt</filename> image that includes everything in 114 tools appropriate for real-time use.</para></listitem>
122 <filename>meta-toolchain</filename>. 115 <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis>
123 The image also includes development headers and libraries to form a complete 116 A <filename>core-image-rt</filename> image that includes everything in
124 stand-alone SDK and is suitable for development using the target. 117 <filename>meta-toolchain</filename>.
125 </para></listitem> 118 The image also includes development headers and libraries to form a complete
126 <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis> 119 stand-alone SDK and is suitable for development using the target.
127 An image with Sato support, a mobile environment and visual style that works well 120 </para></listitem>
128 with mobile devices. 121 <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis>
129 The image supports X11 with a Sato theme and applications such as 122 An image with Sato support, a mobile environment and visual style that works well
130 a terminal, editor, file manager, media player, and so forth. 123 with mobile devices.
131 </para></listitem> 124 The image supports X11 with a Sato theme and applications such as
132 <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis> 125 a terminal, editor, file manager, media player, and so forth.
133 A <filename>core-image-sato</filename> image suitable for development 126 </para></listitem>
134 using the host. 127 <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis>
135 The image includes libraries needed to build applications on the device itself, 128 A <filename>core-image-sato</filename> image suitable for development
136 testing and profiling tools, and debug symbols. 129 using the host.
137 This image was formerly <filename>core-image-sdk</filename>. 130 The image includes libraries needed to build applications on the device itself,
138 </para></listitem> 131 testing and profiling tools, and debug symbols.
139 <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis> 132 This image was formerly <filename>core-image-sdk</filename>.
140 A <filename>core-image-sato</filename> image that includes everything in meta-toolchain. 133 </para></listitem>
141 The image also includes development headers and libraries to form a complete standalone SDK 134 <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis>
142 and is suitable for development using the target.</para></listitem> 135 A <filename>core-image-sato</filename> image that includes everything in meta-toolchain.
143 <listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis> 136 The image also includes development headers and libraries to form a complete standalone SDK
144 A "master" image designed to be used for automated runtime testing. 137 and is suitable for development using the target.</para></listitem>
145 Provides a "known good" image that is deployed to a separate 138 <listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis>
146 partition so that you can boot into it and use it to deploy a 139 A "master" image designed to be used for automated runtime testing.
147 second image to be tested. 140 Provides a "known good" image that is deployed to a separate
148 You can find more information about runtime testing in the 141 partition so that you can boot into it and use it to deploy a
149 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" 142 second image to be tested.
150 section in the Yocto Project Development Manual. 143 You can find more information about runtime testing in the
151 </para></listitem> 144 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
152 <listitem><para><emphasis><filename>core-image-testmaster-initramfs</filename>:</emphasis> 145 section in the Yocto Project Development Manual.
153 A RAM-based Initial Root Filesystem (initramfs) image tailored for 146 </para></listitem>
154 use with the <filename>core-image-testmaster</filename> image. 147 <listitem><para><emphasis><filename>core-image-testmaster-initramfs</filename>:</emphasis>
155 </para></listitem> 148 A RAM-based Initial Root Filesystem (initramfs) image tailored for
156 <listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis> 149 use with the <filename>core-image-testmaster</filename> image.
157 A very basic Wayland image with a terminal. 150 </para></listitem>
158 This image provides the Wayland protocol libraries and the 151 <listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis>
159 reference Weston compositor. 152 A very basic Wayland image with a terminal.
160 For more information, see the 153 This image provides the Wayland protocol libraries and the
161 "<link linkend='wayland'>Wayland</link>" section. 154 reference Weston compositor.
162 </para></listitem> 155 For more information, see the
163 <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis> 156 "<link linkend='wayland'>Wayland</link>" section.
164 A very basic X11 image with a terminal. 157 </para></listitem>
165 </para></listitem> 158 <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis>
166 <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis> 159 A very basic X11 image with a terminal.
167 An image that launches into the demo application for the embedded 160 </para></listitem>
168 (not based on X11) version of Qt.</para></listitem> 161 <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis>
169 </itemizedlist> 162 An image that launches into the demo application for the embedded
163 (not based on X11) version of Qt.</para></listitem>
164 </itemizedlist>
165 </para>
170</chapter> 166</chapter>
171<!-- 167<!--
172vim: expandtab tw=80 ts=4 168vim: expandtab tw=80 ts=4