aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev/kernel-dev-advanced.xml
diff options
context:
space:
mode:
authorscott-lenovo <scott-lenovo@ubuntu.(none)>2013-01-08 09:21:49 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-16 15:59:16 +0000
commit76f1ffe77a4646df01f67010f89ea4b5cd166e0c (patch)
tree5e2582f7a49985a1063ab52f3897d79a93bc9942 /documentation/kernel-dev/kernel-dev-advanced.xml
parentd176d86a4c4f3eea54bc8da8c61338e2ef39d68c (diff)
downloadopenembedded-core-contrib-76f1ffe77a4646df01f67010f89ea4b5cd166e0c.tar.gz
kernel-dev: Edits to the "Configuration" section.
First real re-write of this original text. (From yocto-docs rev: a6d16b61057df8ed811cf1f5f27c5f9e08be1108) Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)> 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.xml33
1 files changed, 19 insertions, 14 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index c069ddfb08..7d82b54f65 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -699,14 +699,17 @@ meta/cfg/kernel-cache/ if you are creating meta-data in-tree (see 3.2.2).
<title>Configuration</title>
<para>
- The simplest unit of metadata is the configuration-only feature.
- It consists of one or more Linux kernel configuration parameters
- in a configuration fragment file (<filename>.cfg</filename>)
- and an <filename>scc</filename> file describing the fragment.
+ The simplest unit of kernel Metadata is the configuration-only
+ feature.
+ This feature consists of one or more Linux kernel configuration
+ parameters in a configuration fragment file
+ (<filename>.cfg</filename>) and an <filename>.scc</filename> file
+ that describes the fragment.
</para>
<para>
- The SMP fragment included in the linux-yocto-3.4 Git repository
+ The Symmetric Multi-Processing (SMP) fragment included in the
+ <filename>linux-yocto-3.4</filename> Git repository
consists of the following two files:
<literallayout class='monospaced'>
cfg/smp.scc:
@@ -718,7 +721,7 @@ meta/cfg/kernel-cache/ if you are creating meta-data in-tree (see 3.2.2).
CONFIG_SCHED_SMT=y
</literallayout>
You can find information on configuration fragment files in the
- "<ulink url='&YOCTO_DOCS_REF_URL;#creating-config-fragments'>Creating Configuration Fragments</ulink>"
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-config-fragments'>Creating Configuration Fragments</ulink>"
section of the Yocto Project Development Manual and in
the "<link linkend='generating-configuration-files'>Generating Configuration Files</link>"
section earlier in this manual.
@@ -726,31 +729,33 @@ meta/cfg/kernel-cache/ if you are creating meta-data in-tree (see 3.2.2).
<para>
<filename>KFEATURE_DESCRIPTION</filename> provides a short
- description of the fragment, the primary use is for higher level
- tooling, such as the Yocto Project BSP Tools (TODO:Citation).
+ description of the fragment.
+ Higher level kernel tools use this description.
</para>
<para>
The <filename>kconf</filename> command is used to include the
- actual configuration fragment in an <filename>scc</filename>
+ actual configuration fragment in an <filename>.scc</filename>
file, and the "hardware" keyword identifies the fragment as
being hardware enabling, as opposed to general policy,
- which would use the keyword "non-hardware".
+ which would use the "non-hardware" keyword.
The distinction is made for the benefit of the configuration
- validation tools, which will warn you if a hardware fragment
+ validation tools, which warn you if a hardware fragment
overrides a policy set by a non-hardware fragment.
+ <note>
+ The description file can include multiple
+ <filename>kconf</filename> statements, one per fragment.
+ </note>
</para>
<para>
As described in the
"<link linkend='generating-configuration-files'>Generating Configuration Files</link>"
- section, the following BitBake command can be used to audit your
+ section, you can use the following BitBake command to audit your
configuration:
<literallayout class='monospaced'>
$ bitbake linux-yocto -c kernel_configcheck -f
</literallayout>
- The description file can include multiple <filename>kconf</filename>
- statements, one per fragment.
</para>
<para>