summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-01-23 23:29:11 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-27 13:56:05 (GMT)
commit5053b654163d5cb209206144f079f42453c6ec1b (patch)
treee13ff44c3cd87b34939512d54f904ed8e00e0ebd /documentation/kernel-dev
parentdd46994f45d5733915d7fa7a7fe7e2a7f50abe58 (diff)
downloadpoky-5053b654163d5cb209206144f079f42453c6ec1b.tar.gz
kernel-dev: General edits and links added.
Many links added to the glossary variables that were introduced in the manual. Also provided general edits as I found them. (From yocto-docs rev: 1c004144669306e87ad783df766b5245e474f549) 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')
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.xml48
1 files changed, 27 insertions, 21 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index 43dec92..ba288d1 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -82,10 +82,10 @@
82 The linux-yocto style recipes can optionally define the following 82 The linux-yocto style recipes can optionally define the following
83 variables: 83 variables:
84 <literallayout class='monospaced'> 84 <literallayout class='monospaced'>
85 KBRANCH 85 <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'>KBRANCH</ulink>
86 KERNEL_FEATURES 86 <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES'>KERNEL_FEATURES</ulink>
87 KBRANCH_DEFAULT 87 <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH_DEFAULT'>KBRANCH_DEFAULT</ulink>
88 LINUX_KERNEL_TYPE 88 <ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'>LINUX_KERNEL_TYPE</ulink>
89 </literallayout> 89 </literallayout>
90 <filename>KBRANCH_DEFAULT</filename> defines the Linux kernel source 90 <filename>KBRANCH_DEFAULT</filename> defines the Linux kernel source
91 repository's default branch to use to build the Linux kernel. 91 repository's default branch to use to build the Linux kernel.
@@ -104,7 +104,8 @@
104 used in assembling the configuration. 104 used in assembling the configuration.
105 If you do not specify a <filename>LINUX_KERNEL_TYPE</filename>, 105 If you do not specify a <filename>LINUX_KERNEL_TYPE</filename>,
106 it defaults to "standard". 106 it defaults to "standard".
107 Together with <filename>KMACHINE</filename>, 107 Together with
108 <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink>,
108 <filename>LINUX_KERNEL_TYPE</filename> defines the search 109 <filename>LINUX_KERNEL_TYPE</filename> defines the search
109 arguments used by the kernel tools to find the 110 arguments used by the kernel tools to find the
110 appropriate description within the kernel Metadata with which to 111 appropriate description within the kernel Metadata with which to
@@ -139,7 +140,8 @@
139 then for the <filename>LINUX_KERNEL_TYPE</filename>. 140 then for the <filename>LINUX_KERNEL_TYPE</filename>.
140 If the tools cannot find a partial match, they will use the 141 If the tools cannot find a partial match, they will use the
141 sources from the <filename>KBRANCH</filename> and any configuration 142 sources from the <filename>KBRANCH</filename> and any configuration
142 specified in the <filename>SRC_URI</filename>. 143 specified in the
144 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>.
143 </para> 145 </para>
144 146
145 <para> 147 <para>
@@ -394,19 +396,20 @@
394 description files within the structure: 396 description files within the structure:
395 <itemizedlist> 397 <itemizedlist>
396 <listitem><para>If your file contains 398 <listitem><para>If your file contains
397 only configuration fragments, place the file in 399 only configuration fragments, place the file in the
398 <filename>cfg</filename>.</para></listitem> 400 <filename>cfg</filename> directory.</para></listitem>
399 <listitem><para>If your file contains 401 <listitem><para>If your file contains
400 only source-code fixes, place the file in 402 only source-code fixes, place the file in the
401 <filename>patches</filename>.</para></listitem> 403 <filename>patches</filename> directory.</para></listitem>
402 <listitem><para>If your file encapsulates 404 <listitem><para>If your file encapsulates
403 a major feature, often combining sources and configurations, 405 a major feature, often combining sources and configurations,
404 place the file in <filename>features</filename>. 406 place the file in <filename>features</filename> directory.
405 </para></listitem> 407 </para></listitem>
406 <listitem><para>If your file aggregates 408 <listitem><para>If your file aggregates
407 non-hardware configuration and patches in order to define a 409 non-hardware configuration and patches in order to define a
408 base kernel policy or major kernel type to be reused across 410 base kernel policy or major kernel type to be reused across
409 multiple BSPs, place the file in <filename>ktypes</filename>. 411 multiple BSPs, place the file in <filename>ktypes</filename>
412 directory.
410 </para></listitem> 413 </para></listitem>
411 </itemizedlist> 414 </itemizedlist>
412 </para> 415 </para>
@@ -466,8 +469,8 @@
466 </para> 469 </para>
467 470
468 <para> 471 <para>
469 <filename>KFEATURE_DESCRIPTION</filename> provides a short 472 <ulink url='&YOCTO_DOCS_REF_URL;#var-KFEATURE_DESCRIPTION'><filename>KFEATURE_DESCRIPTION</filename></ulink>
470 description of the fragment. 473 provides a short description of the fragment.
471 Higher level kernel tools use this description. 474 Higher level kernel tools use this description.
472 </para> 475 </para>
473 476
@@ -653,7 +656,8 @@
653 It is not strictly necessary to create a kernel type 656 It is not strictly necessary to create a kernel type
654 <filename>.scc</filename> file. 657 <filename>.scc</filename> file.
655 The Board Support Package (BSP) file can implicitly define 658 The Board Support Package (BSP) file can implicitly define
656 the kernel type using a <filename>define KTYPE myktype</filename> 659 the kernel type using a <filename>define
660 <ulink url='&YOCTO_DOCS_REF_URL;#var-KTYPE'>KTYPE</ulink> myktype</filename>
657 line. 661 line.
658 See the "<link linkend='bsp-descriptions'>BSP Descriptions</link>" 662 See the "<link linkend='bsp-descriptions'>BSP Descriptions</link>"
659 section for more information. 663 section for more information.
@@ -680,13 +684,15 @@
680 kconf mybsp.cfg 684 kconf mybsp.cfg
681 </literallayout> 685 </literallayout>
682 Every BSP description should define the 686 Every BSP description should define the
683 <filename>KMACHINE</filename>, <filename>KTYPE</filename>, 687 <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink>,
684 and <filename>KARCH</filename> variables. 688 <ulink url='&YOCTO_DOCS_REF_URL;#var-KTYPE'><filename>KTYPE</filename></ulink>,
689 and <ulink url='&YOCTO_DOCS_REF_URL;#var-KARCH'><filename>KARCH</filename></ulink>
690 variables.
685 These variables allow the OpenEmbedded build system to identify 691 These variables allow the OpenEmbedded build system to identify
686 the description as meeting the criteria set by the recipe being 692 the description as meeting the criteria set by the recipe being
687 built. 693 built.
688 This simple example supports the "mybsp" machine for the "standard" 694 This simple example supports the "mybsp" machine for the "standard"
689 kernel and the 'i386" architecture. 695 kernel and the "i386" architecture.
690 </para> 696 </para>
691 697
692 <para> 698 <para>
@@ -695,9 +701,9 @@
695 description file does not exist. 701 description file does not exist.
696 Thus, if you do not have kernel types defined in your kernel 702 Thus, if you do not have kernel types defined in your kernel
697 Metadata, you only need to ensure that the kernel recipe's 703 Metadata, you only need to ensure that the kernel recipe's
698 <filename>LINUX_KERNEL_TYPE</filename> variable and the 704 <ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></ulink>
699 <filename>KTYPE</filename> variable in the BSP description 705 variable and the <filename>KTYPE</filename> variable in the
700 file match. 706 BSP description file match.
701 <note> 707 <note>
702 Future versions of the tooling make the specification of 708 Future versions of the tooling make the specification of
703 <filename>KTYPE</filename> in the BSP optional. 709 <filename>KTYPE</filename> in the BSP optional.