aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev/kernel-dev-advanced.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-12-27 12:44:15 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-16 15:59:11 +0000
commitcaacd30b2789533845436dc3d34e63b1d16ea2bf (patch)
tree02a4ec6037bb70247080ee127cdec8a1c378eeec /documentation/kernel-dev/kernel-dev-advanced.xml
parent1fa2beffa185438ed0f3c1133bf1304b914c6ca0 (diff)
downloadopenembedded-core-contrib-caacd30b2789533845436dc3d34e63b1d16ea2bf.tar.gz
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>
Diffstat (limited to 'documentation/kernel-dev/kernel-dev-advanced.xml')
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.xml65
1 files changed, 65 insertions, 0 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index c669357477..9872bf6859 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -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>
+