kernel-dev: Re-write of the "Features" section.

first real re-write of this section.

(From yocto-docs rev: 09a9d0978d939f40782179f9fd46ccd7b999c262)

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-01-08 10:09:29 -08:00 committed by Richard Purdie
parent 472d58a06e
commit 48f8d9c2cc

View File

@ -849,17 +849,14 @@ The description file can include multiple patch statements, one per patch.
<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.
Features are complex kernel Metadata types that consist
of configuration fragments (<filename>kconf</filename>), patches
(<filename>patch</filename>), and possibly other feature
description files (<filename>include</filename>).
</para>
<para>
A hypothetical example of a feature description file might look
like the following:
Here is an example that shows a feature description file:
<literallayout class='monospaced'>
features/myfeature.scc
define KFEATURE_DESCRIPTION "Enable myfeature"
@ -870,12 +867,15 @@ The description file can include multiple patch statements, one per patch.
include cfg/myfeature_dependency.scc
kconf non-hardware myfeature.cfg
</literallayout>
This example shows how the <filename>patch</filename> and
<filename>kconf</filename> commands are used as well as
how an additional feature description file is included.
</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
Typically, features are less granular than configuration
fragments and are more likely than configuration fragments
and patches to be the types of things you want to specify
in the <filename>KERNEL_FEATURES</filename> variable of the
Linux kernel recipe.
See the "<link linkend='using-kernel-metadata-in-a-recipe'>Using Kernel Metadata in a Recipe</link>"