documentation/poky-ref-manual/ref-images.xml: Updated the list of images.

The list of images has grown. I added all images reported in the 1.1_M2 build using the 'ls meta*/recipes*/images/*.bb' command. (From yocto-docs rev: 62e12a71c73a5e3a20c6887d754a96eb9e754b48) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
author: Scott Rifenbark <scott.m.rifenbark@intel.com> 2011-08-02 09:22:56 -0700
committer: Richard Purdie <richard.purdie@linuxfoundation.org> 2011-08-15 15:26:57 +0100
commit: 52435ce88080fb4c9a8fbb51fa0cc242b491c319 (patch)
tree: f817d74c086d438486598af9ce94f8eee4ffa899
parent: 898e161009333cf12f05ae8c9739af210ba25577 (diff)
download: poky-52435ce88080fb4c9a8fbb51fa0cc242b491c319.tar.gz
1 files changed, 142 insertions, 29 deletions
diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml
index 7bfca2af41..646e441c17 100644
--- a/documentation/poky-ref-manual/ref-images.xml
+++ b/documentation/poky-ref-manual/ref-images.xml
@@ -5,12 +5,9 @@
    <title>Reference: Images</title>
    <para>
-        Poky has several standard images covering most people's standard needs. 
+        The Yocto Project build process supports several types of images to satisfy different needs.  
-        Use the following command to list the supported images:
+        When you issue the <filename>bitbake</filename> command you provide a “top-level” recipe 
-        <literallayout class='monospaced'>
+        that essentially begins the build for the type of image you want.
-     $ ls meta*/recipes*/images/*.bb
-        </literallayout>
-        Images are listed below along with details of what they contain:
    </para>
    <note>
@@ -25,66 +22,182 @@
        </literallayout>
    </note>
+    <para>
+        From within the <filename>poky</filename> Git repository use the following command to list 
+        the supported images:
+        <literallayout class='monospaced'>
+     $ ls meta*/recipes*/images/*.bb
+        </literallayout>
+        These recipes reside in the <filename>meta/recipes-core/images</filename>,
+        <filename>meta/recipes-extended/images</filename>, 
+        <filename>meta/recipes-graphics/images</filename>, and 
+        <filename>meta/recipes-sato/images</filename> directories of your local Yocto Project 
+        file structure (Git repository or extracted release tarball).  
+        Although the recipe names are somewhat explanatory, here is a list that describes them:
+    </para>
    <itemizedlist>
            <listitem>
                <para>
-                    <emphasis>core-image-minimal</emphasis> - A small image just capable 
+                    <emphasis><filename>core-image-base</filename></emphasis> - A console-only image that fully 
+                    supports the target device hardware. 
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-core</filename></emphasis> - An X11 image with simple 
+                    applications such as terminal, editor, and file manager.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-minimal</filename></emphasis> - A small image just capable 
                    of allowing a device to boot.
                </para>
            </listitem>
            <listitem>
                <para>
-                    <emphasis>core-image-base</emphasis> - A console-only image that fully 
+                    <emphasis><filename>core-image-minimal-dev</filename></emphasis> – A 
-                    supports the target device hardware. 
+                    <filename>core-image-minimal</filename> image suitable for 
+                    development work.
                </para>
            </listitem>
            <listitem>
                <para>
-                    <emphasis>core-image-core</emphasis> - An X11 image with simple 
+                    <emphasis><filename>core-image-minimal-directdisk</filename></emphasis> – A 
-                    applications such as terminal, editor, and file manager.
+                    <filename>core-image-minimal</filename>  image that you can 
+                    copy directly to the disk of the target device.
                </para>
            </listitem>
            <listitem>
                <para>
-                    <emphasis>core-image-sato</emphasis> - An X11 image with Sato theme and
+                    <emphasis><filename>core-image-minimal-initramfs</filename></emphasis> – 
-                    Pimlico applications. 
+                    A <filename>core-image-minimal</filename> image that has the Minimal RAM-based 
-                    The image also contains terminal, editor, and file manager.
+                    Initial Root Filesystem (<filename>initramfs</filename>) as part of the kernel, 
+                    which allows the system to find the first “init” program more efficiently.
                </para>
            </listitem>
            <listitem>
                <para>
-                    <emphasis>core-image-sato-dev</emphasis> - An X11 image similar to 
+                    <emphasis><filename>core-image-minimal-live</filename></emphasis> – A 
-                    core-image-sato but
+                    <filename>core-image-minimal</filename> image you can run from a 
-                    also includes a native toolchain and libraries needed to build applications 
+                    USB device or CD as is.
-                    on the device itself. The image also includes testing and profiling tools 
-                    as well as debug symbols.  This image was formerly core-image-sdk.
                </para>
            </listitem>
            <listitem>
                <para>
-                    <emphasis>core-image-lsb</emphasis> - An image suitable for implementations 
+                    <emphasis><filename>core-image-minimal-mtdutils</filename></emphasis> – A 
+                    <filename>core-image-minimal</filename> image that has support 
+                    for the Minimal MTD Utilities, which let the user interact with the 
+                    MTD subsystem in the kernel to perform operations on flash devices.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-basic</filename></emphasis> – A foundational 
+                    basic image without support 
+                    for X that can be reasonably used for customization.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-lsb</filename></emphasis> - A
+                    <filename>core-image-basic</filename> image suitable for implementations 
                    that conform to Linux Standard Base (LSB).
                </para>
            </listitem>
            <listitem>
                <para>
-                    <emphasis>meta-toolchain</emphasis> - This image generates a tarball 
+                    <emphasis><filename>core-image-lsb-dev</filename></emphasis> - A
-                    that contains a stand-alone toolchain that can be used externally to Poky. 
+                    <filename>core-image-lsb</filename> image that is suitable for development work.
-                    The tarball is self-contained and unpacks to the 
+                </para>
-                    <filename class="directory">/opt/poky</filename> directory. 
+            </listitem>
-                    The tarball also contains a copy of QEMU and the scripts necessary to run 
+            <listitem>
-                    poky QEMU images.
+                <para>
+                    <emphasis><filename>core-image-lsb-live</filename></emphasis> - A
+                    <filename>core-image-lsb</filename> image that you run from a USB device or CD as is.
                </para>
            </listitem>
            <listitem>
                <para>
-                    <emphasis>meta-toolchain-sdk</emphasis> - This image includes everything in 
+                    <emphasis><filename>core-image-lsb-sdk</filename></emphasis> - A
-                    meta-toolchain but also includes development headers and libraries
+                    <filename>core-image-lsb</filename> that includes everything in meta-toolchain 
-                    to form a complete standalone SDK. 
+                    but also includes development 
+                    headers and libraries to form a complete standalone SDK. 
                    See the <link linkend='platdev-appdev-external-sdk'> 
                    External Development Using the Poky SDK</link> section for more information.
                </para>
            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-lsb-sdk-live</filename></emphasis> - A 
+                    <filename>core-image-lsb-sdk</filename> image with the ability to run the image
+                    from a USB device or CD as is.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-clutter</filename></emphasis> - An image with 
+                    support for 
+                    the Open GL-based toolkit Clutter, which enables development of rich and animated
+                    graphical user interaces.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-sato</filename></emphasis> - An image with Sato support, 
+                    a mobile environment and visual style that works well with mobile devices.
+                    The image supports X11 with a Sato theme and Pimlico applications and also  
+                    contains terminal, editor, and file manager.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-sato-dev</filename></emphasis> - A
+                    <filename>core-image-sato</filename> image suitable for development
+                    that also includes a native toolchain and libraries needed to build applications on 
+                    the device itself. 
+                    The image also includes testing and profiling tools as well as debug symbols.  
+                    This image was formerly <filename>core-image-sdk</filename>.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-sato-directdisk</filename></emphasis> - A
+                    <filename>core-image-sato</filename> image that can be copied directly to the 
+                    disk of the target device.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-sato-live</filename></emphasis> - A
+                    <filename>core-image-sato</filename> image with the ability to run 
+                    from a USB device or CD as is.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-sato-sdk</filename></emphasis> - A
+                    <filename>core-image-sato</filename> image that includes everything in meta-toolchain. 
+                    The image also includes development headers and libraries to form a complete standalone SDK. 
+                    See the <link linkend='platdev-appdev-external-sdk'> 
+                    External Development Using the Poky SDK</link> section for more information..
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-sato-sdk-directdisk</filename></emphasis> - A
+                    <filename>core-image-sato-sdk</filename> image that can be copied directly to the 
+                    disk of the target device.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis><filename>core-image-sato-sdk-live</filename></emphasis> - A
+                    <filename>core-image-sato-sdk</filename> image that you can run  
+                    from a USB device or CD as is.
+                </para>
+            </listitem>
    </itemizedlist>
 </appendix>
 <!--
author	Scott Rifenbark <scott.m.rifenbark@intel.com>	2011-08-02 09:22:56 -0700
committer	Richard Purdie <richard.purdie@linuxfoundation.org>	2011-08-15 15:26:57 +0100
commit	52435ce88080fb4c9a8fbb51fa0cc242b491c319 (patch)
tree	f817d74c086d438486598af9ce94f8eee4ffa899
parent	898e161009333cf12f05ae8c9739af210ba25577 (diff)
download	poky-52435ce88080fb4c9a8fbb51fa0cc242b491c319.tar.gz

diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml index 7bfca2af41..646e441c17 100644 --- a/documentation/poky-ref-manual/ref-images.xml +++ b/documentation/poky-ref-manual/ref-images.xml
@@ -5,12 +5,9 @@
5	<title>Reference: Images</title>	5	<title>Reference: Images</title>
6		6
7	<para>	7	<para>
8	Poky has several standard images covering most people's standard needs.	8	The Yocto Project build process supports several types of images to satisfy different needs.
9	Use the following command to list the supported images:	9	When you issue the <filename>bitbake</filename> command you provide a “top-level” recipe
10	<literallayout class='monospaced'>	10	that essentially begins the build for the type of image you want.
11	$ ls meta/recipes/images/*.bb
12	</literallayout>
13	Images are listed below along with details of what they contain:
14	</para>	11	</para>
15		12
16	<note>	13	<note>
@@ -25,66 +22,182 @@
25	</literallayout>	22	</literallayout>
26	</note>	23	</note>
27		24
		25	<para>
		26	From within the <filename>poky</filename> Git repository use the following command to list
		27	the supported images:
		28	<literallayout class='monospaced'>
		29	$ ls meta/recipes/images/*.bb
		30	</literallayout>
		31	These recipes reside in the <filename>meta/recipes-core/images</filename>,
		32	<filename>meta/recipes-extended/images</filename>,
		33	<filename>meta/recipes-graphics/images</filename>, and
		34	<filename>meta/recipes-sato/images</filename> directories of your local Yocto Project
		35	file structure (Git repository or extracted release tarball).
		36	Although the recipe names are somewhat explanatory, here is a list that describes them:
		37	</para>
		38
28	<itemizedlist>	39	<itemizedlist>
29	<listitem>	40	<listitem>
30	<para>	41	<para>
31	<emphasis>core-image-minimal</emphasis> - A small image just capable	42	<emphasis><filename>core-image-base</filename></emphasis> - A console-only image that fully
		43	supports the target device hardware.
		44	</para>
		45	</listitem>
		46	<listitem>
		47	<para>
		48	<emphasis><filename>core-image-core</filename></emphasis> - An X11 image with simple
		49	applications such as terminal, editor, and file manager.
		50	</para>
		51	</listitem>
		52	<listitem>
		53	<para>
		54	<emphasis><filename>core-image-minimal</filename></emphasis> - A small image just capable
32	of allowing a device to boot.	55	of allowing a device to boot.
33	</para>	56	</para>
34	</listitem>	57	</listitem>
35	<listitem>	58	<listitem>
36	<para>	59	<para>
37	<emphasis>core-image-base</emphasis> - A console-only image that fully	60	<emphasis><filename>core-image-minimal-dev</filename></emphasis> – A
38	supports the target device hardware.	61	<filename>core-image-minimal</filename> image suitable for
		62	development work.
39	</para>	63	</para>
40	</listitem>	64	</listitem>
41	<listitem>	65	<listitem>
42	<para>	66	<para>
43	<emphasis>core-image-core</emphasis> - An X11 image with simple	67	<emphasis><filename>core-image-minimal-directdisk</filename></emphasis> – A
44	applications such as terminal, editor, and file manager.	68	<filename>core-image-minimal</filename> image that you can
		69	copy directly to the disk of the target device.
45	</para>	70	</para>
46	</listitem>	71	</listitem>
47	<listitem>	72	<listitem>
48	<para>	73	<para>
49	<emphasis>core-image-sato</emphasis> - An X11 image with Sato theme and	74	<emphasis><filename>core-image-minimal-initramfs</filename></emphasis> –
50	Pimlico applications.	75	A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
51	The image also contains terminal, editor, and file manager.	76	Initial Root Filesystem (<filename>initramfs</filename>) as part of the kernel,
		77	which allows the system to find the first “init” program more efficiently.
52	</para>	78	</para>
53	</listitem>	79	</listitem>
54	<listitem>	80	<listitem>
55	<para>	81	<para>
56	<emphasis>core-image-sato-dev</emphasis> - An X11 image similar to	82	<emphasis><filename>core-image-minimal-live</filename></emphasis> – A
57	core-image-sato but	83	<filename>core-image-minimal</filename> image you can run from a
58	also includes a native toolchain and libraries needed to build applications	84	USB device or CD as is.
59	on the device itself. The image also includes testing and profiling tools
60	as well as debug symbols. This image was formerly core-image-sdk.
61	</para>	85	</para>
62	</listitem>	86	</listitem>
63	<listitem>	87	<listitem>
64	<para>	88	<para>
65	<emphasis>core-image-lsb</emphasis> - An image suitable for implementations	89	<emphasis><filename>core-image-minimal-mtdutils</filename></emphasis> – A
		90	<filename>core-image-minimal</filename> image that has support
		91	for the Minimal MTD Utilities, which let the user interact with the
		92	MTD subsystem in the kernel to perform operations on flash devices.
		93	</para>
		94	</listitem>
		95	<listitem>
		96	<para>
		97	<emphasis><filename>core-image-basic</filename></emphasis> – A foundational
		98	basic image without support
		99	for X that can be reasonably used for customization.
		100	</para>
		101	</listitem>
		102	<listitem>
		103	<para>
		104	<emphasis><filename>core-image-lsb</filename></emphasis> - A
		105	<filename>core-image-basic</filename> image suitable for implementations
66	that conform to Linux Standard Base (LSB).	106	that conform to Linux Standard Base (LSB).
67	</para>	107	</para>
68	</listitem>	108	</listitem>
69	<listitem>	109	<listitem>
70	<para>	110	<para>
71	<emphasis>meta-toolchain</emphasis> - This image generates a tarball	111	<emphasis><filename>core-image-lsb-dev</filename></emphasis> - A
72	that contains a stand-alone toolchain that can be used externally to Poky.	112	<filename>core-image-lsb</filename> image that is suitable for development work.
73	The tarball is self-contained and unpacks to the	113	</para>
74	<filename class="directory">/opt/poky</filename> directory.	114	</listitem>
75	The tarball also contains a copy of QEMU and the scripts necessary to run	115	<listitem>
76	poky QEMU images.	116	<para>
		117	<emphasis><filename>core-image-lsb-live</filename></emphasis> - A
		118	<filename>core-image-lsb</filename> image that you run from a USB device or CD as is.
77	</para>	119	</para>
78	</listitem>	120	</listitem>
79	<listitem>	121	<listitem>
80	<para>	122	<para>
81	<emphasis>meta-toolchain-sdk</emphasis> - This image includes everything in	123	<emphasis><filename>core-image-lsb-sdk</filename></emphasis> - A
82	meta-toolchain but also includes development headers and libraries	124	<filename>core-image-lsb</filename> that includes everything in meta-toolchain
83	to form a complete standalone SDK.	125	but also includes development
		126	headers and libraries to form a complete standalone SDK.
84	See the <link linkend='platdev-appdev-external-sdk'>	127	See the <link linkend='platdev-appdev-external-sdk'>
85	External Development Using the Poky SDK</link> section for more information.	128	External Development Using the Poky SDK</link> section for more information.
86	</para>	129	</para>
87	</listitem>	130	</listitem>
		131	<listitem>
		132	<para>
		133	<emphasis><filename>core-image-lsb-sdk-live</filename></emphasis> - A
		134	<filename>core-image-lsb-sdk</filename> image with the ability to run the image
		135	from a USB device or CD as is.
		136	</para>
		137	</listitem>
		138	<listitem>
		139	<para>
		140	<emphasis><filename>core-image-clutter</filename></emphasis> - An image with
		141	support for
		142	the Open GL-based toolkit Clutter, which enables development of rich and animated
		143	graphical user interaces.
		144	</para>
		145	</listitem>
		146	<listitem>
		147	<para>
		148	<emphasis><filename>core-image-sato</filename></emphasis> - An image with Sato support,
		149	a mobile environment and visual style that works well with mobile devices.
		150	The image supports X11 with a Sato theme and Pimlico applications and also
		151	contains terminal, editor, and file manager.
		152	</para>
		153	</listitem>
		154	<listitem>
		155	<para>
		156	<emphasis><filename>core-image-sato-dev</filename></emphasis> - A
		157	<filename>core-image-sato</filename> image suitable for development
		158	that also includes a native toolchain and libraries needed to build applications on
		159	the device itself.
		160	The image also includes testing and profiling tools as well as debug symbols.
		161	This image was formerly <filename>core-image-sdk</filename>.
		162	</para>
		163	</listitem>
		164	<listitem>
		165	<para>
		166	<emphasis><filename>core-image-sato-directdisk</filename></emphasis> - A
		167	<filename>core-image-sato</filename> image that can be copied directly to the
		168	disk of the target device.
		169	</para>
		170	</listitem>
		171	<listitem>
		172	<para>
		173	<emphasis><filename>core-image-sato-live</filename></emphasis> - A
		174	<filename>core-image-sato</filename> image with the ability to run
		175	from a USB device or CD as is.
		176	</para>
		177	</listitem>
		178	<listitem>
		179	<para>
		180	<emphasis><filename>core-image-sato-sdk</filename></emphasis> - A
		181	<filename>core-image-sato</filename> image that includes everything in meta-toolchain.
		182	The image also includes development headers and libraries to form a complete standalone SDK.
		183	See the <link linkend='platdev-appdev-external-sdk'>
		184	External Development Using the Poky SDK</link> section for more information..
		185	</para>
		186	</listitem>
		187	<listitem>
		188	<para>
		189	<emphasis><filename>core-image-sato-sdk-directdisk</filename></emphasis> - A
		190	<filename>core-image-sato-sdk</filename> image that can be copied directly to the
		191	disk of the target device.
		192	</para>
		193	</listitem>
		194	<listitem>
		195	<para>
		196	<emphasis><filename>core-image-sato-sdk-live</filename></emphasis> - A
		197	<filename>core-image-sato-sdk</filename> image that you can run
		198	from a USB device or CD as is.
		199	</para>
		200	</listitem>
88	</itemizedlist>	201	</itemizedlist>
89	</appendix>	202	</appendix>
90	<!--	203	<!--