sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

ref-manual: Updated to *_FEATURES variables. 

I updated the MACHINE_FEATURES, DISTRO_FEATURES, and
COMBINED_FEATURES variable descriptions to better reflect what
they actually do.  Also, fixed two occurences of IrDA in the
features lists section.

(From yocto-docs rev: 89e40a2f309eacec37fc63c2ef0d4cd440722b2f)

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 2013-11-20 10:36:05 -08:00 committed by Richard Purdie
parent 6fbfd3494f
commit 0ed81805f4
2 changed files with 57 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/ref-manual/ref-features.xml
View File

@ -44,7 +44,7 @@
</para>
<section id='ref-features-distro'>
<title>Distro</title>
<title>Distro Features</title>
<para>
The items below are features you can use with
@ -75,7 +75,7 @@
support.</para></listitem>
<listitem><para><emphasis>ipv6:</emphasis> Include IPv6 support.
</para></listitem>
<listitem><para><emphasis>irda:</emphasis> Include Irda support.
<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).
@ -126,7 +126,7 @@
</section>
<section id='ref-features-machine'>
<title>Machine</title>
<title>Machine Features</title>
<para>
The items below are features you can use with
@ -152,7 +152,7 @@
</para></listitem>
<listitem><para><emphasis>ext2:</emphasis> Hardware HDD or Microdrive
</para></listitem>
<listitem><para><emphasis>irda:</emphasis> Hardware has Irda support
<listitem><para><emphasis>irda:</emphasis> Hardware has IrDA support
</para></listitem>
<listitem><para><emphasis>keyboard:</emphasis> Hardware has a keyboard
</para></listitem>

71
documentation/ref-manual/ref-variables.xml
View File

@ -917,10 +917,27 @@
<glossentry id='var-COMBINED_FEATURES'><glossterm>COMBINED_FEATURES</glossterm>
<glossdef>
<para>A set of features common between
<para>
Provides a list of hardware features that are enabled in
both
<link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>
and <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
See the glossary descriptions for these variables for more information.</para>
and
<link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
This select list of features is a list features that make
sense to be controlled both at the machine and distribution
configuration level.
For example, the "bluetooth" feature requires hardware
support but should also be optional at the distribution
level, in case the hardware supports Bluetooth but you
do not ever intend to use it.
</para>
<para>
For more information, see the
<link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>
and <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>
variables.
</para>
</glossdef>
</glossentry>
@ -1306,10 +1323,25 @@
<glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm>
<glossdef>
<para>The features enabled for the distribution.
For a list of supported features that ship with the
Yocto Project, see the
"<link linkend='ref-features-distro'>Distro</link>"
<para>
The software support you want in your distribution for
various features.
In most cases, the presence or absence of a feature in
<filename>DISTRO_FEATURES</filename> is translated to the
appropriate option supplied to the configure script
during <filename>do_configure</filename> for recipes that
optionally support the feature.
For example, specifying x11 in
<filename>DISTRO_FEATURES</filename>, causes
every piece of software built for the target that can
optionally support X11 to have its X11 support enabled.
</para>
<para>
Two more examples are Bluetooth and NFS support.
For a more complete features that ship with the Yocto
Project that you can provide using this variable, see the
"<link linkend='ref-features-distro'>Distro Features</link>"
section.
</para>
</glossdef>
@ -3344,20 +3376,23 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm>
<glossdef>
<para>Specifies the list of hardware features the
<link linkend='var-MACHINE'>MACHINE</link> supports.
For example, including the "bluetooth" feature causes the
<filename>bluez</filename> bluetooth daemon to be built and
added to the image.
It also causes the <filename>connman</filename> recipe
to look at <filename>MACHINE_FEATURES</filename> and when it
finds "bluetooth" there it enables the bluetooth
support in ConnMan.
<para>
Specifies the list of hardware features the
<link linkend='var-MACHINE'><filename>MACHINE</filename></link> is capable
of supporting.
For related information on enabling features, see the
<link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>,
<link linkend='var-COMBINED_FEATURES'><filename>COMBINED_FEATURES</filename></link>,
and
<link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
variables.
</para>
<para>
For a list of features supported by the Yocto Project as shipped,
see the "<link linkend='ref-features-machine'>Machine</link>" section.
For a list of hardware features supported by the Yocto
Project as shipped, see the
"<link linkend='ref-features-machine'>Machine Features</link>"
section.
</para>
</glossdef>
</glossentry>