summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-10-03 09:20:01 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-10-06 12:06:34 +0100
commitf83991dc04a266375eb0254cb7f8ad9c69e4b944 (patch)
tree6ba2d36aacd3ac8c3ba9c3cced157500cb591cd3 /documentation
parent398a00a74c3dda82b7cb9fdf95718df0bf2dd0b9 (diff)
downloadpoky-f83991dc04a266375eb0254cb7f8ad9c69e4b944.tar.gz
ref-manual: Updated KERNEL_FEATURES variable description
Added a more relevant example from the 4.12 Yocto Linux kernel recipe. (From yocto-docs rev: 98c40729b2b22a2ac8444d899848c05880cb920b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml57
1 files changed, 33 insertions, 24 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 13e683fbd5..c85efc65ff 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7166,41 +7166,50 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7166 7166
7167 <glossentry id='var-KERNEL_FEATURES'><glossterm>KERNEL_FEATURES</glossterm> 7167 <glossentry id='var-KERNEL_FEATURES'><glossterm>KERNEL_FEATURES</glossterm>
7168 <info> 7168 <info>
7169 KERNEL_FEATURES[doc] = "Includes additional metadata from the Yocto Project kernel Git repository. The metadata you add through this variable includes config fragments and features descriptions." 7169 KERNEL_FEATURES[doc] = "Includes additional kernel metadata. The metadata you add through this variable includes config fragments and features descriptions."
7170 </info> 7170 </info>
7171 <glossdef> 7171 <glossdef>
7172 <para role="glossdeffirst"> 7172 <para role="glossdeffirst">
7173<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 7173<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7174 Includes additional metadata from the Yocto Project kernel Git repository. 7174 Includes additional kernel metadata.
7175 In the OpenEmbedded build system, the default Board Support Packages (BSPs) 7175 In the OpenEmbedded build system, the default Board Support
7176 Packages (BSPs)
7176 <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink> 7177 <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>
7177 is provided through 7178 is provided through
7178 the <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link> 7179 the <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link>
7179 and <link linkend='var-KBRANCH'><filename>KBRANCH</filename></link> variables. 7180 and
7180 You can use the <filename>KERNEL_FEATURES</filename> variable to further 7181 <link linkend='var-KBRANCH'><filename>KBRANCH</filename></link>
7181 add metadata for all BSPs. 7182 variables.
7183 You can use the <filename>KERNEL_FEATURES</filename>
7184 variable from within the kernel recipe or kernel append
7185 file to further add metadata for all BSPs or specific
7186 BSPs.
7182 </para> 7187 </para>
7183 7188
7184 <para> 7189 <para>
7185 The metadata you add through this variable includes config fragments and 7190 The metadata you add through this variable includes config
7186 features descriptions, 7191 fragments and features descriptions,
7187 which usually includes patches as well as config fragments. 7192 which usually includes patches as well as config fragments.
7188 You typically override the <filename>KERNEL_FEATURES</filename> variable 7193 You typically override the
7189 for a specific machine. 7194 <filename>KERNEL_FEATURES</filename> variable for a
7190 In this way, you can provide validated, but optional, sets of kernel 7195 specific machine.
7191 configurations and features. 7196 In this way, you can provide validated, but optional,
7192 </para> 7197 sets of kernel configurations and features.
7193 7198 </para>
7194 <para> 7199
7195 For example, the following adds <filename>netfilter</filename> to all 7200 <para>
7196 the Yocto Project kernels and adds sound support to the <filename>qemux86</filename> 7201 For example, the following example from the
7197 machine: 7202 <filename>linux-yocto-rt_4.12</filename> kernel recipe
7198 <literallayout class='monospaced'> 7203 adds "netfilter" and "taskstats" features to all BSPs
7199 # Add netfilter to all linux-yocto kernels 7204 as well as "virtio" configurations to all QEMU machines.
7200 KERNEL_FEATURES="features/netfilter/netfilter.scc" 7205 The last two statements add specific configurations to
7201 7206 targeted machine types:
7202 # Add sound support to the qemux86 machine 7207 <literallayout class='monospaced'>
7203 KERNEL_FEATURES_append_qemux86=" cfg/sound.scc" 7208 KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc features/taskstats/taskstats.scc"
7209 KERNEL_FEATURES_append = " ${KERNEL_EXTRA_FEATURES}"
7210 KERNEL_FEATURES_append_qemuall=" cfg/virtio.scc"
7211 KERNEL_FEATURES_append_qemux86=" cfg/sound.scc cfg/paravirt_kvm.scc"
7212 KERNEL_FEATURES_append_qemux86-64=" cfg/sound.scc"
7204 </literallayout></para> 7213 </literallayout></para>
7205 </glossdef> 7214 </glossdef>
7206 </glossentry> 7215 </glossentry>