kernel-dev: Formatted "Features" section.

(From yocto-docs rev: 500ae50979dad7f730d8c0a5e987c608422f3c71)

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
2012-12-27 12:44:15 -06:00
committed by Richard Purdie
parent 1fa2beffa1
commit caacd30b27

View File

@@ -806,6 +806,71 @@ The description file can include multiple patch statements, one per patch.
</para>
</section>
<section id='features'>
<title>Features</title>
<para>
Features are a combination of configuration fragments and patches.
Or, more accurately, configuration fragments and patches are
simple forms of a feature, which is a more complex metadata type.
In addition to the <filename>kconf</filename> and
<filename>patch</filename> commands, features often aggregate
description files with the <filename>include</filename> command.
</para>
<para>
A hypothetical example of a feature description file might look
like the following:
<literallayout class='monospaced'>
features/myfeature.scc
define KFEATURE_DESCRIPTION "Enable myfeature"
patch 0001-myfeature-core.patch
patch 0002-myfeature-interface.patch
include cfg/myfeature_dependency.scc
kconf non-hardware myfeature.cfg
</literallayout>
</para>
<para>
Features are typically less granular than configuration
fragments and are more likely than configurations fragments
and patches to be the types of things you will want to specify
in the <filename>KERNEL_FEATURES</filename> variable of the
Linux kernel recipe.
See the "<link linkend='using-metadata-in-a-recipe'>Using Metadata in a Recipe</link>"
section earlier in the manual.
</para>
<para>
Original text:
<literallayout class='monospaced'>
Features are a combination of configuration fragments and patches, or, more
accurately, configuration fragments and patches are simple forms of a feature, a
more complex meta-data type. In addition to the kconf and patch commands,
features often aggregate description files with the include command.
A hypothetical example of a feature description file might look like the
following:
features/myfeature.scc
define KFEATURE_DESCRIPTION "Enable myfeature"
patch 0001-myfeature-core.patch
patch 0002-myfeature-interface.patch
include cfg/myfeature_dependency.scc
kconf non-hardware myfeature.cfg
Features are typically less granular than configuration fragments and are more
likely than configurations fragments and patches to be the types of things you
will want to specify in the KERNEL_FEATURES variable of the Linux kernel recipe
(see 3.1).
</literallayout>
</para>
</section>