diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2011-08-19 13:03:07 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-08-23 18:47:06 -0700 |
commit | 87f4bfd0a39a146b49f57d82dc642ef6d039a5d1 (patch) | |
tree | 7603aa296ca333397d34fa383022bd07f91a41eb /documentation/poky-ref-manual/ref-features.xml | |
parent | 5b171729f2fc50abadcd26d2e19b6443dd83f546 (diff) | |
download | ast2050-yocto-poky-87f4bfd0a39a146b49f57d82dc642ef6d039a5d1.zip ast2050-yocto-poky-87f4bfd0a39a146b49f57d82dc642ef6d039a5d1.tar.gz |
documentation/poky-ref-manual/ref-features.xml: Cleaned up list formatting.
(From yocto-docs rev: 1813848d673dedae6b918676eec1f3926ee630f2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/poky-ref-manual/ref-features.xml')
-rw-r--r-- | documentation/poky-ref-manual/ref-features.xml | 385 |
1 files changed, 122 insertions, 263 deletions
diff --git a/documentation/poky-ref-manual/ref-features.xml b/documentation/poky-ref-manual/ref-features.xml index b9288bc..db51454 100644 --- a/documentation/poky-ref-manual/ref-features.xml +++ b/documentation/poky-ref-manual/ref-features.xml @@ -4,298 +4,157 @@ <appendix id='ref-features'> <title>Reference: Features</title> - <para>'Features' provide a mechanism for working out which packages - should be included in the generated images. Distributions can - select which features they want to support through the - <glossterm linkend='var-DISTRO_FEATURES'><link - linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></glossterm> - variable which is set in the distribution configuration file - (poky.conf for Poky). Machine features are set in the - <glossterm linkend='var-MACHINE_FEATURES'><link - linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></glossterm> - variable which is set in the machine configuration file and - specifies which hardware features a given machine has. + <para> + Features provide a mechanism for working out which packages + should be included in the generated images. + Distributions can select which features they want to support through the + <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename> + variable, which is set in the <filename>poky.conf</filename> distributioni configuration file. + Machine features are set in the + <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename> + variable, which is set in the machine configuration file and + specifies the hardware features for a given machine. </para> - <para>These two variables are combined to work out which kernel modules, - utilities and other packages to include. A given distribution can - support a selected subset of features so some machine features might not - be included if the distribution itself doesn't support them. + <para> + These two variables combine to work out which kernel modules, + utilities, and other packages to include. + A given distribution can support a selected subset of features so some machine features might not + be included if the distribution itself does not support them. </para> <section id='ref-features-distro'> <title>Distro</title> - <para>The items below are valid options for <glossterm linkend='var-DISTRO_FEATURES'><link - linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></glossterm>. - </para> - - <itemizedlist> - <listitem> - <para> - alsa - ALSA support will be included (OSS compatibility - kernel modules will be installed if available) - </para> - </listitem> - <listitem> - <para> - bluetooth - Include bluetooth support (integrated BT only) - </para> - </listitem> - <listitem> - <para> - ext2 - Include tools for supporting for devices with internal + <para> + The items below are valid options for + <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>: + <itemizedlist> + <listitem><para><emphasis>alsa:</emphasis>ALSA support will be included (OSS compatibility + kernel modules will be installed if available).</para></listitem> + <listitem><para><emphasis>bluetooth:</emphasis> Include bluetooth support (integrated BT only) + </para></listitem> + <listitem><para><emphasis>ext2:</emphasis> Include tools for supporting for devices with internal HDD/Microdrive for storing files (instead of Flash only devices) - </para> - </listitem> - <listitem> - <para> - irda - Include Irda support - </para> - </listitem> - <listitem> - <para> - keyboard - Include keyboard support (e.g. keymaps will be + </para></listitem> + <listitem><para><emphasis>irda:</emphasis> Include Irda support + </para></listitem> + <listitem><para><emphasis>keyboard:</emphasis> Include keyboard support (e.g. keymaps will be loaded during boot). - </para> - </listitem> - <listitem> - <para> - pci - Include PCI bus support - </para> - </listitem> - <listitem> - <para> - pcmcia - Include PCMCIA/CompactFlash support - </para> - </listitem> - <listitem> - <para> - usbgadget - USB Gadget Device support (for USB + </para></listitem> + <listitem><para><emphasis>pci:</emphasis> Include PCI bus support + </para></listitem> + <listitem><para><emphasis>pcmcia:</emphasis> Include PCMCIA/CompactFlash support + </para></listitem> + <listitem><para><emphasis>usbgadget:</emphasis> USB Gadget Device support (for USB networking/serial/storage) - </para> - </listitem> - <listitem> - <para> - usbhost - USB Host support (allows to connect external + </para></listitem> + <listitem><para><emphasis>usbhost:</emphasis> USB Host support (allows to connect external keyboard, mouse, storage, network etc) - </para> - </listitem> - <listitem> - <para> - wifi - WiFi support (integrated only) - </para> - </listitem> - <listitem> - <para> - cramfs - CramFS support - </para> - </listitem> - <listitem> - <para> - ipsec - IPSec support - </para> - </listitem> - <listitem> - <para> - ipv6 - IPv6 support - </para> - </listitem> - <listitem> - <para> - nfs - NFS client support (for mounting NFS exports on - device) - </para> - </listitem> - <listitem> - <para> - ppp - PPP dialup support - </para> - </listitem> - <listitem> - <para> - smbfs - SMB networks client support (for mounting - Samba/Microsoft Windows shares on device) - </para> - </listitem> - </itemizedlist> + </para></listitem> + <listitem><para><emphasis>wifi:</emphasis> WiFi support (integrated only) + </para></listitem> + <listitem><para><emphasis>cramfs:</emphasis> CramFS support + </para></listitem> + <listitem><para><emphasis>ipsec:</emphasis> IPSec support + </para></listitem> + <listitem><para><emphasis>ipv6:</emphasis> IPv6 support + </para></listitem> + <listitem><para><emphasis>nfs:</emphasis> NFS client support (for mounting NFS exports on + device)</para></listitem> + <listitem><para><emphasis>ppp:</emphasis> PPP dialup support</para></listitem> + <listitem><para><emphasis>smbfs:</emphasis> SMB networks client support (for mounting + Samba/Microsoft Windows shares on device)</para></listitem> + </itemizedlist> + </para> </section> <section id='ref-features-machine'> <title>Machine</title> - <para>The items below are valid options for <glossterm linkend='var-MACHINE_FEATURES'><link - linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></glossterm>. + <para> + The items below are valid options for + <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>: + <itemizedlist> + <listitem><para><emphasis>acpi:</emphasis> Hardware has ACPI (x86/x86_64 only) + </para></listitem> + <listitem><para><emphasis>alsa:</emphasis> Hardware has ALSA audio drivers + </para></listitem> + <listitem><para><emphasis>apm:</emphasis> Hardware uses APM (or APM emulation) + </para></listitem> + <listitem><para><emphasis>bluetooth:</emphasis> Hardware has integrated BT + </para></listitem> + <listitem><para><emphasis>ext2:</emphasis> Hardware HDD or Microdrive + </para></listitem> + <listitem><para><emphasis>irda:</emphasis> Hardware has Irda support + </para></listitem> + <listitem><para><emphasis>keyboard:</emphasis> Hardware has a keyboard + </para></listitem> + <listitem><para><emphasis>pci:</emphasis> Hardware has a PCI bus + </para></listitem> + <listitem><para><emphasis>pcmcia:</emphasis> Hardware has PCMCIA or CompactFlash sockets + </para></listitem> + <listitem><para><emphasis>screen:</emphasis> Hardware has a screen + </para></listitem> + <listitem><para><emphasis>serial:</emphasis> Hardware has serial support (usually RS232) + </para></listitem> + <listitem><para><emphasis>touchscreen:</emphasis> Hardware has a touchscreen + </para></listitem> + <listitem><para><emphasis>usbgadget:</emphasis> Hardware is USB gadget device capable + </para></listitem> + <listitem><para><emphasis>usbhost:</emphasis> Hardware is USB Host capable + </para></listitem> + <listitem><para><emphasis>wifi:</emphasis> Hardware has integrated WiFi + </para></listitem> + </itemizedlist> </para> - - <itemizedlist> - <listitem> - <para> - acpi - Hardware has ACPI (x86/x86_64 only) - </para> - </listitem> - <listitem> - <para> - alsa - Hardware has ALSA audio drivers - </para> - </listitem> - <listitem> - <para> - apm - Hardware uses APM (or APM emulation) - </para> - </listitem> - <listitem> - <para> - bluetooth - Hardware has integrated BT - </para> - </listitem> - <listitem> - <para> - ext2 - Hardware HDD or Microdrive - </para> - </listitem> - <listitem> - <para> - irda - Hardware has Irda support - </para> - </listitem> - <listitem> - <para> - keyboard - Hardware has a keyboard - </para> - </listitem> - <listitem> - <para> - pci - Hardware has a PCI bus - </para> - </listitem> - <listitem> - <para> - pcmcia - Hardware has PCMCIA or CompactFlash sockets - </para> - </listitem> - <listitem> - <para> - screen - Hardware has a screen - </para> - </listitem> - <listitem> - <para> - serial - Hardware has serial support (usually RS232) - </para> - </listitem> - <listitem> - <para> - touchscreen - Hardware has a touchscreen - </para> - </listitem> - <listitem> - <para> - usbgadget - Hardware is USB gadget device capable - </para> - </listitem> - <listitem> - <para> - usbhost - Hardware is USB Host capable - </para> - </listitem> - <listitem> - <para> - wifi - Hardware has integrated WiFi - </para> - </listitem> - </itemizedlist> </section> <section id='ref-features-image'> <title>Reference: Images</title> <para> - The contents of images generated by Poky can be controlled by the - <glossterm linkend='var-IMAGE_FEATURES'><link linkend='var-IMAGE_FEATURES'> - IMAGE_FEATURES</link></glossterm> variable and the in local.conf and the - <glossterm linkend='var-EXTRA_IMAGE_FEATURES'><link linkend='var-EXTRA_IMAGE_FEATURES'> - EXTRA_IMAGE_FEATURES</link></glossterm> that you typically configure in your image recipes. - Through these varibales you can add several different + The contents of images generated by the Yocto Project can be controlled by the + <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> + and <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> + variables that you typically configure in your image recipes. + Through these variables you can add several different predefined packages such as development utilities or packages with debug information needed to investigate application problems or profile applications. </para> <para> - Current list of <glossterm - linkend='var-IMAGE_FEATURES'><link - linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></glossterm> contains: + Current list of + <filename>IMAGE_FEATURES</filename> contains the following: + <itemizedlist> + <listitem><para><emphasis>apps-console-core:</emphasis> Core console applications such as + <filename>ssh</filename>, <filename>daemon</filename>, <filename>avahi daemon</filename>, + <filename>portmap</filename> (for mounting NFS shares)</para></listitem> + <listitem><para><emphasis>x11-base:</emphasis> X11 server + minimal desktop</para></listitem> + <listitem><para><emphasis>x11-sato:</emphasis> OpenedHand Sato environment</para></listitem> + <listitem><para><emphasis>apps-x11-core:</emphasis> Core X11 applications such as an + X Terminal, file manager, and file editor</para></listitem> + <listitem><para><emphasis>apps-x11-games:</emphasis> A set of X11 games</para></listitem> + <listitem><para><emphasis>apps-x11-pimlico:</emphasis> OpenedHand Pimlico application suite + </para></listitem> + <listitem><para><emphasis>tools-sdk:</emphasis> A full SDK that runs on the device + </para></listitem> + <listitem><para><emphasis>tools-debug:</emphasis> Debugging tools such as + <filename>strace</filename> and <filename>gdb</filename> + </para></listitem> + <listitem><para><emphasis>tools-profile:</emphasis> Profiling tools such as + <filename>oprofile</filename>, <filename>exmap</filename>, and + <filename>LTTng</filename></para></listitem> + <listitem><para><emphasis>tools-testapps:</emphasis> Device testing tools (e.g. + touchscreen debugging)</para></listitem> + <listitem><para><emphasis>nfs-server:</emphasis> NFS server (exports / over NFS + to everybody)</para></listitem> + <listitem><para><emphasis>dev-pkgs:</emphasis> Development packages (headers and + extra library links) for all packages installed in a given image</para></listitem> + <listitem><para><emphasis>dbg-pkgs:</emphasis> Debug packages for all packages + installed in a given image</para></listitem> + </itemizedlist> </para> - - <itemizedlist> - <listitem> - <para> - apps-console-core - Core console applications such as ssh daemon, - avahi daemon, portmap (for mounting NFS shares) - </para> - </listitem> - <listitem> - <para> - x11-base - X11 server + minimal desktop - </para> - </listitem> - <listitem> - <para> - x11-sato - OpenedHand Sato environment - </para> - </listitem> - <listitem> - <para> - apps-x11-core - Core X11 applications such as an X Terminal, file manager, file editor - </para> - </listitem> - <listitem> - <para> - apps-x11-games - A set of X11 games - </para> - </listitem> - <listitem> - <para> - apps-x11-pimlico - OpenedHand Pimlico application suite - </para> - </listitem> - <listitem> - <para> - tools-sdk - A full SDK which runs on device - </para> - </listitem> - <listitem> - <para> - tools-debug - Debugging tools such as strace and gdb - </para> - </listitem> - <listitem> - <para> - tools-profile - Profiling tools such as oprofile, exmap and LTTng - </para> - </listitem> - <listitem> - <para> - tools-testapps - Device testing tools (e.g. touchscreen debugging) - </para> - </listitem> - <listitem> - <para> - nfs-server - NFS server (exports / over NFS to everybody) - </para> - </listitem> - <listitem> - <para> - dev-pkgs - Development packages (headers and extra library links) for all packages - installed in a given image - </para> - </listitem> - <listitem> - <para> - dbg-pkgs - Debug packages for all packages installed in a given image - </para> - </listitem> - </itemizedlist> </section> </appendix> |