diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-03-28 08:07:42 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-04-04 14:13:36 +0100 |
commit | d72c0e688d6b38fffc5202ee4b0b6cf8749ad3b6 (patch) | |
tree | 711d794fac23c0e51190b5bfa68fb866fb66f852 /documentation/ref-manual | |
parent | e73fc8e047a19a5edd8979fff3900659615ef00a (diff) | |
download | poky-d72c0e688d6b38fffc5202ee4b0b6cf8749ad3b6.tar.gz |
ref-manual: Edits to the "Images" section.
Added some cross-references to some other parts of the YP
documentation. Also, re-orderd the list to be alphabetical.
(From yocto-docs rev: c2faf4ab4b9fd0ef2670f5c31deaa933b3119779)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/ref-features.xml | 46 |
1 files changed, 27 insertions, 19 deletions
diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml index 18f43c1c5c..fcf9e9c342 100644 --- a/documentation/ref-manual/ref-features.xml +++ b/documentation/ref-manual/ref-features.xml | |||
@@ -168,7 +168,7 @@ | |||
168 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> | 168 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> |
169 | and <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> | 169 | and <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> |
170 | variables that you typically configure in your image recipes. | 170 | variables that you typically configure in your image recipes. |
171 | Through these variables you can add several different | 171 | Through these variables, you can add several different |
172 | predefined packages such as development utilities or packages with debug | 172 | predefined packages such as development utilities or packages with debug |
173 | information needed to investigate application problems or profile applications. | 173 | information needed to investigate application problems or profile applications. |
174 | </para> | 174 | </para> |
@@ -177,6 +177,13 @@ | |||
177 | Current list of | 177 | Current list of |
178 | <filename>IMAGE_FEATURES</filename> contains the following: | 178 | <filename>IMAGE_FEATURES</filename> contains the following: |
179 | <itemizedlist> | 179 | <itemizedlist> |
180 | <listitem><para><emphasis>dbg-pkgs:</emphasis> Installs debug symbol packages for all packages | ||
181 | installed in a given image.</para></listitem> | ||
182 | <listitem><para><emphasis>dev-pkgs:</emphasis> Installs development packages (headers and | ||
183 | extra library links) for all packages installed in a given image.</para></listitem> | ||
184 | <listitem><para><emphasis>doc-pkgs:</emphasis> Installs documentation packages for all packages | ||
185 | installed in a given image.</para></listitem> | ||
186 | <listitem><para><emphasis>nfs-server:</emphasis> Installs an NFS server.</para></listitem> | ||
180 | <listitem><para><emphasis>splash:</emphasis> Enables showing a splash screen during boot. | 187 | <listitem><para><emphasis>splash:</emphasis> Enables showing a splash screen during boot. |
181 | By default, this screen is provided by <filename>psplash</filename>, which does | 188 | By default, this screen is provided by <filename>psplash</filename>, which does |
182 | allow customization. | 189 | allow customization. |
@@ -192,31 +199,32 @@ | |||
192 | Note that if both the OpenSSH SSH server and the Dropbear minimal SSH server | 199 | Note that if both the OpenSSH SSH server and the Dropbear minimal SSH server |
193 | are present in <filename>IMAGE_FEATURES</filename>, then OpenSSH will take | 200 | are present in <filename>IMAGE_FEATURES</filename>, then OpenSSH will take |
194 | precedence and Dropbear will not be installed.</para></listitem> | 201 | precedence and Dropbear will not be installed.</para></listitem> |
195 | <listitem><para><emphasis>x11:</emphasis> Installs the X server</para></listitem> | 202 | <listitem><para><emphasis>staticdev-pkgs:</emphasis> Installs static development |
196 | <listitem><para><emphasis>x11-base:</emphasis> Installs the X server with a | 203 | packages (i.e. static libraries containing <filename>*.a</filename> files) for all |
197 | minimal environment.</para></listitem> | 204 | packages installed in a given image.</para></listitem> |
198 | <listitem><para><emphasis>x11-sato:</emphasis> Installs the OpenedHand Sato environment. | ||
199 | </para></listitem> | ||
200 | <listitem><para><emphasis>tools-sdk:</emphasis> Installs a full SDK that runs on the device. | ||
201 | </para></listitem> | ||
202 | <listitem><para><emphasis>tools-debug:</emphasis> Installs debugging tools such as | 205 | <listitem><para><emphasis>tools-debug:</emphasis> Installs debugging tools such as |
203 | <filename>strace</filename> and <filename>gdb</filename>. | 206 | <filename>strace</filename> and <filename>gdb</filename>. |
207 | For information on GDB, see the | ||
208 | "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" | ||
209 | section in the Yocto Project Development Manual. | ||
210 | For information on tracing and profiling, see the | ||
211 | <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>. | ||
204 | </para></listitem> | 212 | </para></listitem> |
205 | <listitem><para><emphasis>tools-profile:</emphasis> Installs profiling tools such as | 213 | <listitem><para><emphasis>tools-profile:</emphasis> Installs profiling tools such as |
206 | <filename>oprofile</filename>, <filename>exmap</filename>, and | 214 | <filename>oprofile</filename>, <filename>exmap</filename>, and |
207 | <filename>LTTng</filename>.</para></listitem> | 215 | <filename>LTTng</filename>. |
216 | For general information on user-space tools, see the | ||
217 | "<ulink url='&YOCTO_DOCS_ADT_URL;#user-space-tools'>User-Space Tools</ulink>" | ||
218 | section in the Yocto Project Application Developer's Guide.</para></listitem> | ||
219 | <listitem><para><emphasis>tools-sdk:</emphasis> Installs a full SDK that runs on the device. | ||
220 | </para></listitem> | ||
208 | <listitem><para><emphasis>tools-testapps:</emphasis> Installs device testing tools (e.g. | 221 | <listitem><para><emphasis>tools-testapps:</emphasis> Installs device testing tools (e.g. |
209 | touchscreen debugging).</para></listitem> | 222 | touchscreen debugging).</para></listitem> |
210 | <listitem><para><emphasis>nfs-server:</emphasis> Installs an NFS server.</para></listitem> | 223 | <listitem><para><emphasis>x11:</emphasis> Installs the X server</para></listitem> |
211 | <listitem><para><emphasis>dev-pkgs:</emphasis> Installs development packages (headers and | 224 | <listitem><para><emphasis>x11-base:</emphasis> Installs the X server with a |
212 | extra library links) for all packages installed in a given image.</para></listitem> | 225 | minimal environment.</para></listitem> |
213 | <listitem><para><emphasis>staticdev-pkgs:</emphasis> Installs static development | 226 | <listitem><para><emphasis>x11-sato:</emphasis> Installs the OpenedHand Sato environment. |
214 | packages (i.e. static libraries containing <filename>*.a</filename> files) for all | 227 | </para></listitem> |
215 | packages installed in a given image.</para></listitem> | ||
216 | <listitem><para><emphasis>dbg-pkgs:</emphasis> Installs debug symbol packages for all packages | ||
217 | installed in a given image.</para></listitem> | ||
218 | <listitem><para><emphasis>doc-pkgs:</emphasis> Installs documentation packages for all packages | ||
219 | installed in a given image.</para></listitem> | ||
220 | </itemizedlist> | 228 | </itemizedlist> |
221 | </para> | 229 | </para> |
222 | </section> | 230 | </section> |