diff options
-rw-r--r-- | documentation/ref-manual/ref-features.xml | 163 |
1 files changed, 115 insertions, 48 deletions
diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml index 242dfe0737..cc4f3456c1 100644 --- a/documentation/ref-manual/ref-features.xml +++ b/documentation/ref-manual/ref-features.xml | |||
@@ -207,51 +207,109 @@ | |||
207 | <title>Image Features</title> | 207 | <title>Image Features</title> |
208 | 208 | ||
209 | <para> | 209 | <para> |
210 | The contents of images generated by the OpenEmbedded build system can be controlled by the | 210 | The contents of images generated by the OpenEmbedded build system |
211 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> | 211 | can be controlled by the |
212 | and <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> | 212 | <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> |
213 | and | ||
214 | <link linkend='var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></link> | ||
213 | variables that you typically configure in your image recipes. | 215 | variables that you typically configure in your image recipes. |
214 | Through these variables, you can add several different | 216 | Through these variables, you can add several different |
215 | predefined packages such as development utilities or packages with debug | 217 | predefined packages such as development utilities or packages with |
216 | information needed to investigate application problems or profile applications. | 218 | debug information needed to investigate application problems or |
219 | profile applications. | ||
217 | </para> | 220 | </para> |
218 | 221 | ||
219 | <para> | 222 | <para> |
220 | Current list of | 223 | The bulk of image features are available only when you inherit the |
221 | <filename>IMAGE_FEATURES</filename> contains the following: | 224 | <link linkend='ref-classes-core-image'><filename>core-image</filename></link> |
225 | class. | ||
226 | However, some features, as noted in the following list, are | ||
227 | available to all images. | ||
228 | The current list of valid <filename>IMAGE_FEATURES</filename> | ||
229 | is as follows: | ||
222 | <itemizedlist> | 230 | <itemizedlist> |
223 | <listitem><para><emphasis>dbg-pkgs:</emphasis> Installs debug symbol packages for all packages | 231 | <listitem><para><emphasis>dbg-pkgs:</emphasis> |
224 | installed in a given image.</para></listitem> | 232 | Installs debug symbol packages for all packages installed |
225 | <listitem><para><emphasis>dev-pkgs:</emphasis> Installs development packages (headers and | 233 | in a given image. |
226 | extra library links) for all packages installed in a given image.</para></listitem> | 234 | </para></listitem> |
227 | <listitem><para><emphasis>doc-pkgs:</emphasis> Installs documentation packages for all packages | 235 | <listitem><para><emphasis>dbg-tweaks:</emphasis> |
228 | installed in a given image.</para></listitem> | 236 | Makes an image suitable for development (e.g. |
229 | <listitem><para><emphasis>nfs-server:</emphasis> Installs an NFS server.</para></listitem> | 237 | allows root logins without passwords). |
230 | <listitem><para><emphasis>read-only-rootfs:</emphasis> Creates | 238 | The <filename>dbg-tweaks</filename> feature is |
231 | an image whose root filesystem is read-only. | 239 | available for all images regardless of whether or not |
240 | the <filename>core-image</filename> class is inherited. | ||
241 | </para></listitem> | ||
242 | <listitem><para><emphasis>dev-pkgs:</emphasis> | ||
243 | Installs development packages (headers and extra library | ||
244 | links) for all packages installed in a given image. | ||
245 | </para></listitem> | ||
246 | <listitem><para><emphasis>doc-pkgs:</emphasis> Installs | ||
247 | documentation packages for all packages installed in a | ||
248 | given image. | ||
249 | </para></listitem> | ||
250 | <listitem><para><emphasis>eclipse-debug:</emphasis> Provides | ||
251 | Eclipse remote debugging support. | ||
252 | </para></listitem> | ||
253 | <listitem><para><emphasis>hwcodecs:</emphasis> Installs | ||
254 | hardware acceleration codecs. | ||
255 | </para></listitem> | ||
256 | <listitem><para><emphasis>nfs-server:</emphasis> | ||
257 | Installs an NFS server. | ||
258 | </para></listitem> | ||
259 | <listitem><para><emphasis>package-management:</emphasis> | ||
260 | Installs package management tools and preserves the package | ||
261 | manager database. | ||
262 | The <filename>package-management</filename> feature is | ||
263 | available for all images regardless of whether or not | ||
264 | the <filename>core-image</filename> class is inherited. | ||
265 | </para></listitem> | ||
266 | <listitem><para><emphasis>ptest-pkgs:</emphasis> | ||
267 | Installs ptest packages for all ptest-enabled recipes. | ||
268 | </para></listitem> | ||
269 | <listitem><para><emphasis>qt4-pkgs:</emphasis> | ||
270 | Supports Qt4/X11 and demo applications. | ||
271 | </para></listitem> | ||
272 | <listitem><para><emphasis>read-only-rootfs:</emphasis> | ||
273 | Creates an image whose root filesystem is read-only. | ||
232 | See the | 274 | See the |
233 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>" | 275 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>" |
234 | section in the Yocto Project Development Manual for more | 276 | section in the Yocto Project Development Manual for more |
235 | information.</para></listitem> | 277 | information. |
236 | <listitem><para><emphasis>splash:</emphasis> Enables showing a splash screen during boot. | 278 | The <filename>read-only-rootfs</filename> feature is |
237 | By default, this screen is provided by <filename>psplash</filename>, which does | 279 | available for all images regardless of whether or not |
238 | allow customization. | 280 | the <filename>core-image</filename> class is inherited. |
239 | If you prefer to use an alternative splash screen package, you can do so by | 281 | </para></listitem> |
240 | setting the <filename>SPLASH</filename> variable | 282 | <listitem><para><emphasis>splash:</emphasis> |
241 | to a different package name (or names) within the image recipe or at the distro | 283 | Enables showing a splash screen during boot. |
242 | configuration level.</para></listitem> | 284 | By default, this screen is provided by |
243 | <listitem><para><emphasis>ssh-server-dropbear:</emphasis> Installs the Dropbear minimal | 285 | <filename>psplash</filename>, which does allow |
244 | SSH server. | 286 | customization. |
245 | </para></listitem> | 287 | If you prefer to use an alternative splash screen package, |
246 | <listitem><para><emphasis>ssh-server-openssh:</emphasis> Installs the OpenSSH SSH server, | 288 | you can do so by setting the <filename>SPLASH</filename> |
247 | which is more full-featured than Dropbear. | 289 | variable to a different package name (or names) within the |
248 | Note that if both the OpenSSH SSH server and the Dropbear minimal SSH server | 290 | image recipe or at the distro configuration level. |
249 | are present in <filename>IMAGE_FEATURES</filename>, then OpenSSH will take | 291 | The <filename>splash</filename> feature is |
250 | precedence and Dropbear will not be installed.</para></listitem> | 292 | available for all images regardless of whether or not |
251 | <listitem><para><emphasis>staticdev-pkgs:</emphasis> Installs static development | 293 | the <filename>core-image</filename> class is inherited. |
252 | packages (i.e. static libraries containing <filename>*.a</filename> files) for all | 294 | </para></listitem> |
253 | packages installed in a given image.</para></listitem> | 295 | <listitem><para><emphasis>ssh-server-dropbear:</emphasis> |
254 | <listitem><para><emphasis>tools-debug:</emphasis> Installs debugging tools such as | 296 | Installs the Dropbear minimal SSH server. |
297 | </para></listitem> | ||
298 | <listitem><para><emphasis>ssh-server-openssh:</emphasis> | ||
299 | Installs the OpenSSH SSH server, which is more | ||
300 | full-featured than Dropbear. | ||
301 | Note that if both the OpenSSH SSH server and the Dropbear | ||
302 | minimal SSH server are present in | ||
303 | <filename>IMAGE_FEATURES</filename>, then OpenSSH will take | ||
304 | precedence and Dropbear will not be installed. | ||
305 | </para></listitem> | ||
306 | <listitem><para><emphasis>staticdev-pkgs:</emphasis> | ||
307 | Installs static development packages (i.e. static | ||
308 | libraries containing <filename>*.a</filename> files) for | ||
309 | all packages installed in a given image. | ||
310 | </para></listitem> | ||
311 | <listitem><para><emphasis>tools-debug:</emphasis> | ||
312 | Installs debugging tools such as | ||
255 | <filename>strace</filename> and <filename>gdb</filename>. | 313 | <filename>strace</filename> and <filename>gdb</filename>. |
256 | For information on GDB, see the | 314 | For information on GDB, see the |
257 | "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" | 315 | "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" |
@@ -259,20 +317,29 @@ | |||
259 | For information on tracing and profiling, see the | 317 | For information on tracing and profiling, see the |
260 | <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>. | 318 | <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>. |
261 | </para></listitem> | 319 | </para></listitem> |
262 | <listitem><para><emphasis>tools-profile:</emphasis> Installs profiling tools such as | 320 | <listitem><para><emphasis>tools-profile:</emphasis> |
263 | <filename>oprofile</filename>, <filename>exmap</filename>, and | 321 | Installs profiling tools such as |
264 | <filename>LTTng</filename>. | 322 | <filename>oprofile</filename>, <filename>exmap</filename>, |
323 | and <filename>LTTng</filename>. | ||
265 | For general information on user-space tools, see the | 324 | For general information on user-space tools, see the |
266 | "<ulink url='&YOCTO_DOCS_ADT_URL;#user-space-tools'>User-Space Tools</ulink>" | 325 | "<ulink url='&YOCTO_DOCS_ADT_URL;#user-space-tools'>User-Space Tools</ulink>" |
267 | section in the Yocto Project Application Developer's Guide.</para></listitem> | 326 | section in the Yocto Project Application Developer's |
268 | <listitem><para><emphasis>tools-sdk:</emphasis> Installs a full SDK that runs on the device. | 327 | Guide. |
269 | </para></listitem> | 328 | </para></listitem> |
270 | <listitem><para><emphasis>tools-testapps:</emphasis> Installs device testing tools (e.g. | 329 | <listitem><para><emphasis>tools-sdk:</emphasis> |
271 | touchscreen debugging).</para></listitem> | 330 | Installs a full SDK that runs on the device. |
272 | <listitem><para><emphasis>x11:</emphasis> Installs the X server</para></listitem> | 331 | </para></listitem> |
273 | <listitem><para><emphasis>x11-base:</emphasis> Installs the X server with a | 332 | <listitem><para><emphasis>tools-testapps:</emphasis> |
274 | minimal environment.</para></listitem> | 333 | Installs device testing tools (e.g. touchscreen debugging). |
275 | <listitem><para><emphasis>x11-sato:</emphasis> Installs the OpenedHand Sato environment. | 334 | </para></listitem> |
335 | <listitem><para><emphasis>x11:</emphasis> | ||
336 | Installs the X server. | ||
337 | </para></listitem> | ||
338 | <listitem><para><emphasis>x11-base:</emphasis> | ||
339 | Installs the X server with a minimal environment. | ||
340 | </para></listitem> | ||
341 | <listitem><para><emphasis>x11-sato:</emphasis> | ||
342 | Installs the OpenedHand Sato environment. | ||
276 | </para></listitem> | 343 | </para></listitem> |
277 | </itemizedlist> | 344 | </itemizedlist> |
278 | </para> | 345 | </para> |