summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-02 10:16:53 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-06-18 10:30:43 +0100
commite891596f9329802ff15b859312672951124d81ce (patch)
treed247bfac5c998d469516aa9d85620817ba1b0c6b
parent2aba525b98e59ac64836c8307cb567be07005d49 (diff)
downloadpoky-e891596f9329802ff15b859312672951124d81ce.tar.gz
ref-manual: Edits to the "Images" section.
Added detailed requirements for the three LSB type images in order for the build to create an LSB-compliant image. Massaged the weston image a bit. (From yocto-docs rev: 01fee2bebe76512ab5707212fc8d78df20d83126) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-images.xml39
1 files changed, 19 insertions, 20 deletions
diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml
index e7d76f2b1b..1ef1fb3ade 100644
--- a/documentation/ref-manual/ref-images.xml
+++ b/documentation/ref-manual/ref-images.xml
@@ -79,7 +79,12 @@
79 A console-only image with more full-featured Linux system 79 A console-only image with more full-featured Linux system
80 functionality installed.</para></listitem> 80 functionality installed.</para></listitem>
81 <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis> 81 <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis>
82 An image that conforms to the Linux Standard Base (LSB) specification. 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.
83 </para></listitem> 88 </para></listitem>
84 <listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis> 89 <listitem><para><emphasis><filename>core-image-testmaster</filename>:</emphasis>
85 A "master" image designed to be used for automated runtime testing. 90 A "master" image designed to be used for automated runtime testing.
@@ -95,10 +100,19 @@
95 using the host. 100 using the host.
96 The image includes headers and libraries you can use in a host development 101 The image includes headers and libraries you can use in a host development
97 environment. 102 environment.
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-dev</filename> without that
106 configuration, the image will not be LSB-compliant.
98 </para></listitem> 107 </para></listitem>
99 <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis> 108 <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis>
100 A <filename>core-image-lsb</filename> that includes everything in meta-toolchain 109 A <filename>core-image-lsb</filename> that includes everything in
101 but also includes development headers and libraries to form a complete standalone SDK. 110 meta-toolchain but also includes development headers and libraries
111 to form a complete standalone SDK.
112 This image requires a distribution configuration that
113 enables LSB compliance (e.g. <filename>poky-lsb</filename>).
114 If you build <filename>core-image-lsb-sdk</filename> without that
115 configuration, the image will not be LSB-compliant.
102 This image is suitable for development using the target.</para></listitem> 116 This image is suitable for development using the target.</para></listitem>
103 <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis> 117 <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 118 An image with support for the Open GL-based toolkit Clutter, which enables development of
@@ -110,7 +124,8 @@
110 A very basic X11 image with a terminal. 124 A very basic X11 image with a terminal.
111 </para></listitem> 125 </para></listitem>
112 <listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis> 126 <listitem><para><emphasis><filename>core-image-weston</filename>:</emphasis>
113 An image that provides the Wayland protocol libraries and the 127 A very basic Wayland image with a terminal.
128 This image provides the Wayland protocol libraries and the
114 reference Weston compositor. 129 reference Weston compositor.
115 For more information, see the 130 For more information, see the
116 "<link linkend='wayland'>Wayland</link>" section. 131 "<link linkend='wayland'>Wayland</link>" section.
@@ -144,23 +159,7 @@
144 A <filename>core-image-sato</filename> image that includes everything in meta-toolchain. 159 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 160 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> 161 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> 162 </itemizedlist>
153
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>
164</chapter> 163</chapter>
165<!-- 164<!--
166vim: expandtab tw=80 ts=4 165vim: expandtab tw=80 ts=4