summaryrefslogtreecommitdiffstats
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)
downloadpoky-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).
699 <title>Configuration</title> 699 <title>Configuration</title>
700 700
701 <para> 701 <para>
702 The simplest unit of metadata is the configuration-only feature. 702 The simplest unit of kernel Metadata is the configuration-only
703 It consists of one or more Linux kernel configuration parameters 703 feature.
704 in a configuration fragment file (<filename>.cfg</filename>) 704 This feature consists of one or more Linux kernel configuration
705 and an <filename>scc</filename> file describing the fragment. 705 parameters in a configuration fragment file
706 (<filename>.cfg</filename>) and an <filename>.scc</filename> file
707 that describes the fragment.
706 </para> 708 </para>
707 709
708 <para> 710 <para>
709 The SMP fragment included in the linux-yocto-3.4 Git repository 711 The Symmetric Multi-Processing (SMP) fragment included in the
712 <filename>linux-yocto-3.4</filename> Git repository
710 consists of the following two files: 713 consists of the following two files:
711 <literallayout class='monospaced'> 714 <literallayout class='monospaced'>
712 cfg/smp.scc: 715 cfg/smp.scc:
@@ -718,7 +721,7 @@ meta/cfg/kernel-cache/ if you are creating meta-data in-tree (see 3.2.2).
718 CONFIG_SCHED_SMT=y 721 CONFIG_SCHED_SMT=y
719 </literallayout> 722 </literallayout>
720 You can find information on configuration fragment files in the 723 You can find information on configuration fragment files in the
721 "<ulink url='&YOCTO_DOCS_REF_URL;#creating-config-fragments'>Creating Configuration Fragments</ulink>" 724 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-config-fragments'>Creating Configuration Fragments</ulink>"
722 section of the Yocto Project Development Manual and in 725 section of the Yocto Project Development Manual and in
723 the "<link linkend='generating-configuration-files'>Generating Configuration Files</link>" 726 the "<link linkend='generating-configuration-files'>Generating Configuration Files</link>"
724 section earlier in this manual. 727 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).
726 729
727 <para> 730 <para>
728 <filename>KFEATURE_DESCRIPTION</filename> provides a short 731 <filename>KFEATURE_DESCRIPTION</filename> provides a short
729 description of the fragment, the primary use is for higher level 732 description of the fragment.
730 tooling, such as the Yocto Project BSP Tools (TODO:Citation). 733 Higher level kernel tools use this description.
731 </para> 734 </para>
732 735
733 <para> 736 <para>
734 The <filename>kconf</filename> command is used to include the 737 The <filename>kconf</filename> command is used to include the
735 actual configuration fragment in an <filename>scc</filename> 738 actual configuration fragment in an <filename>.scc</filename>
736 file, and the "hardware" keyword identifies the fragment as 739 file, and the "hardware" keyword identifies the fragment as
737 being hardware enabling, as opposed to general policy, 740 being hardware enabling, as opposed to general policy,
738 which would use the keyword "non-hardware". 741 which would use the "non-hardware" keyword.
739 The distinction is made for the benefit of the configuration 742 The distinction is made for the benefit of the configuration
740 validation tools, which will warn you if a hardware fragment 743 validation tools, which warn you if a hardware fragment
741 overrides a policy set by a non-hardware fragment. 744 overrides a policy set by a non-hardware fragment.
745 <note>
746 The description file can include multiple
747 <filename>kconf</filename> statements, one per fragment.
748 </note>
742 </para> 749 </para>
743 750
744 <para> 751 <para>
745 As described in the 752 As described in the
746 "<link linkend='generating-configuration-files'>Generating Configuration Files</link>" 753 "<link linkend='generating-configuration-files'>Generating Configuration Files</link>"
747 section, the following BitBake command can be used to audit your 754 section, you can use the following BitBake command to audit your
748 configuration: 755 configuration:
749 <literallayout class='monospaced'> 756 <literallayout class='monospaced'>
750 $ bitbake linux-yocto -c kernel_configcheck -f 757 $ bitbake linux-yocto -c kernel_configcheck -f
751 </literallayout> 758 </literallayout>
752 The description file can include multiple <filename>kconf</filename>
753 statements, one per fragment.
754 </para> 759 </para>
755 760
756 <para> 761 <para>