1
0
mirror of https://git.yoctoproject.org/poky synced 2026-06-01 00:59:48 +00:00

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>
This commit is contained in:
Scott Rifenbark
2011-08-19 13:03:07 -07:00
committed by Richard Purdie
parent 5b171729f2
commit 87f4bfd0a3
+122 -263
View File
@@ -4,298 +4,157 @@
<appendix id='ref-features'> <appendix id='ref-features'>
<title>Reference: Features</title> <title>Reference: Features</title>
<para>'Features' provide a mechanism for working out which packages <para>
should be included in the generated images. Distributions can Features provide a mechanism for working out which packages
select which features they want to support through the should be included in the generated images.
<glossterm linkend='var-DISTRO_FEATURES'><link Distributions can select which features they want to support through the
linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></glossterm> <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>
variable which is set in the distribution configuration file variable, which is set in the <filename>poky.conf</filename> distributioni configuration file.
(poky.conf for Poky). Machine features are set in the Machine features are set in the
<glossterm linkend='var-MACHINE_FEATURES'><link <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>
linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></glossterm> variable, which is set in the machine configuration file and
variable which is set in the machine configuration file and specifies the hardware features for a given machine.
specifies which hardware features a given machine has.
</para> </para>
<para>These two variables are combined to work out which kernel modules, <para>
utilities and other packages to include. A given distribution can These two variables combine to work out which kernel modules,
support a selected subset of features so some machine features might not utilities, and other packages to include.
be included if the distribution itself doesn't support them. 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> </para>
<section id='ref-features-distro'> <section id='ref-features-distro'>
<title>Distro</title> <title>Distro</title>
<para>The items below are valid options for <glossterm linkend='var-DISTRO_FEATURES'><link <para>
linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></glossterm>. The items below are valid options for
</para> <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>:
<itemizedlist>
<itemizedlist> <listitem><para><emphasis>alsa:</emphasis>ALSA support will be included (OSS compatibility
<listitem> kernel modules will be installed if available).</para></listitem>
<para> <listitem><para><emphasis>bluetooth:</emphasis> Include bluetooth support (integrated BT only)
alsa - ALSA support will be included (OSS compatibility </para></listitem>
kernel modules will be installed if available) <listitem><para><emphasis>ext2:</emphasis> Include tools for supporting for devices with internal
</para>
</listitem>
<listitem>
<para>
bluetooth - Include bluetooth support (integrated BT only)
</para>
</listitem>
<listitem>
<para>
ext2 - Include tools for supporting for devices with internal
HDD/Microdrive for storing files (instead of Flash only devices) HDD/Microdrive for storing files (instead of Flash only devices)
</para> </para></listitem>
</listitem> <listitem><para><emphasis>irda:</emphasis> Include Irda support
<listitem> </para></listitem>
<para> <listitem><para><emphasis>keyboard:</emphasis> Include keyboard support (e.g. keymaps will be
irda - Include Irda support
</para>
</listitem>
<listitem>
<para>
keyboard - Include keyboard support (e.g. keymaps will be
loaded during boot). loaded during boot).
</para> </para></listitem>
</listitem> <listitem><para><emphasis>pci:</emphasis> Include PCI bus support
<listitem> </para></listitem>
<para> <listitem><para><emphasis>pcmcia:</emphasis> Include PCMCIA/CompactFlash support
pci - Include PCI bus support </para></listitem>
</para> <listitem><para><emphasis>usbgadget:</emphasis> USB Gadget Device support (for USB
</listitem>
<listitem>
<para>
pcmcia - Include PCMCIA/CompactFlash support
</para>
</listitem>
<listitem>
<para>
usbgadget - USB Gadget Device support (for USB
networking/serial/storage) networking/serial/storage)
</para> </para></listitem>
</listitem> <listitem><para><emphasis>usbhost:</emphasis> USB Host support (allows to connect external
<listitem>
<para>
usbhost - USB Host support (allows to connect external
keyboard, mouse, storage, network etc) keyboard, mouse, storage, network etc)
</para> </para></listitem>
</listitem> <listitem><para><emphasis>wifi:</emphasis> WiFi support (integrated only)
<listitem> </para></listitem>
<para> <listitem><para><emphasis>cramfs:</emphasis> CramFS support
wifi - WiFi support (integrated only) </para></listitem>
</para> <listitem><para><emphasis>ipsec:</emphasis> IPSec support
</listitem> </para></listitem>
<listitem> <listitem><para><emphasis>ipv6:</emphasis> IPv6 support
<para> </para></listitem>
cramfs - CramFS support <listitem><para><emphasis>nfs:</emphasis> NFS client support (for mounting NFS exports on
</para> device)</para></listitem>
</listitem> <listitem><para><emphasis>ppp:</emphasis> PPP dialup support</para></listitem>
<listitem> <listitem><para><emphasis>smbfs:</emphasis> SMB networks client support (for mounting
<para> Samba/Microsoft Windows shares on device)</para></listitem>
ipsec - IPSec support </itemizedlist>
</para> </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>
</section> </section>
<section id='ref-features-machine'> <section id='ref-features-machine'>
<title>Machine</title> <title>Machine</title>
<para>The items below are valid options for <glossterm linkend='var-MACHINE_FEATURES'><link <para>
linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></glossterm>. 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> </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>
<section id='ref-features-image'> <section id='ref-features-image'>
<title>Reference: Images</title> <title>Reference: Images</title>
<para> <para>
The contents of images generated by Poky can be controlled by the The contents of images generated by the Yocto Project can be controlled by the
<glossterm linkend='var-IMAGE_FEATURES'><link linkend='var-IMAGE_FEATURES'> <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>
IMAGE_FEATURES</link></glossterm> variable and the in local.conf and the and <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename>
<glossterm linkend='var-EXTRA_IMAGE_FEATURES'><link linkend='var-EXTRA_IMAGE_FEATURES'> variables that you typically configure in your image recipes.
EXTRA_IMAGE_FEATURES</link></glossterm> that you typically configure in your image recipes. Through these variables you can add several different
Through these varibales you can add several different
predefined packages such as development utilities or packages with debug predefined packages such as development utilities or packages with debug
information needed to investigate application problems or profile applications. information needed to investigate application problems or profile applications.
</para> </para>
<para> <para>
Current list of <glossterm Current list of
linkend='var-IMAGE_FEATURES'><link <filename>IMAGE_FEATURES</filename> contains the following:
linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></glossterm> contains: <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> </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> </section>
</appendix> </appendix>