summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-01-23 13:36:00 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-27 13:56:05 +0000
commiteb576addf539e75295c34352ad73a27242156978 (patch)
treeeca06a80a2f2c8a33fb9cb2ab2a225e088cf9938 /documentation
parent64933666a6c75aa04140a4e83e4db09edf85b858 (diff)
downloadpoky-eb576addf539e75295c34352ad73a27242156978.tar.gz
kernel-dev: Links and edits to the Common Tasks chapter.
(From yocto-docs rev: 46cd5eabe2343897eb9b4822064735bf335beb47) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/kernel-dev/kernel-dev-common.xml28
1 files changed, 17 insertions, 11 deletions
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index 475149368b..f6c027e7c5 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -7,7 +7,7 @@
7<title>Common Tasks</title> 7<title>Common Tasks</title>
8 8
9<para> 9<para>
10 This chapter presents several common tasks that are performed when you 10 This chapter presents several common tasks you perform when you
11 work with the Yocto Project Linux kernel. 11 work with the Yocto Project Linux kernel.
12 These tasks include preparing a layer, modifying an existing recipe, 12 These tasks include preparing a layer, modifying an existing recipe,
13 iterative development, working with your own sources, and incorporating 13 iterative development, working with your own sources, and incorporating
@@ -29,7 +29,7 @@
29 sections in the Yocto Project Development Manual: 29 sections in the Yocto Project Development Manual:
30 <itemizedlist> 30 <itemizedlist>
31 <listitem><para>"<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" for 31 <listitem><para>"<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" for
32 general information on layers and how to create them.</para></listitem> 32 general information on layers and how to create layers.</para></listitem>
33 <listitem><para>"<ulink url='&YOCTO_DOCS_DEV_URL;#get-your-layer-setup-for-the-build'>Get Your Layer Setup for the Build</ulink>" for 33 <listitem><para>"<ulink url='&YOCTO_DOCS_DEV_URL;#get-your-layer-setup-for-the-build'>Get Your Layer Setup for the Build</ulink>" for
34 specific instructions on setting up a layer for kernel 34 specific instructions on setting up a layer for kernel
35 development.</para></listitem> 35 development.</para></listitem>
@@ -238,7 +238,7 @@
238 The resulting <filename>.config</filename> file is 238 The resulting <filename>.config</filename> file is
239 located in 239 located in
240 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename> under the 240 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename> under the
241 <filename>linux-${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink><filename>}-${KTYPE}-build</filename> directory. 241 <filename>linux-${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink><filename>}-${<ulink url='&YOCTO_DOCS_REF_URL;#var-KTYPE'><filename>KTYPE</filename></ulink>}-build</filename> directory.
242 You can use the entire <filename>.config</filename> file as the 242 You can use the entire <filename>.config</filename> file as the
243 <filename>defconfig</filename> file as described in the 243 <filename>defconfig</filename> file as described in the
244 "<link linkend='changing-the-configuration'>Changing the Configuration</link>" section. 244 "<link linkend='changing-the-configuration'>Changing the Configuration</link>" section.
@@ -612,11 +612,14 @@
612 612
613 <para> 613 <para>
614 The important point to note here is the 614 The important point to note here is the
615 <filename>KERNEL_SRC</filename> variable. 615 <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_SRC'><filename>KERNEL_SRC</filename></ulink>
616 The module <filename>bbclass</filename> sets this variable, 616 variable.
617 as well as the <filename>KERNEL_PATH</filename> variable 617 The class <filename>module.bbclass</filename> sets this variable,
618 to <filename>${STAGING_KERNEL_DIR}</filename> with the 618 as well as the
619 necessary Linux kernel build information to build modules. 619 <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_PATH'><filename>KERNEL_PATH</filename></ulink>
620 variable to
621 <filename>${<ulink url='&YOCTO_DOCS_REF_URL;#var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></ulink>}</filename>
622 with the necessary Linux kernel build information to build modules.
620 If your module <filename>Makefile</filename> uses a different 623 If your module <filename>Makefile</filename> uses a different
621 variable, you might want to override the 624 variable, you might want to override the
622 <filename>do_compile()</filename> step, or create a patch to 625 <filename>do_compile()</filename> step, or create a patch to
@@ -656,9 +659,12 @@
656 </para> 659 </para>
657 660
658 <para> 661 <para>
659 Because the variable is <filename>RRECOMMENDS</filename> and not 662 Because the variable is
660 a <filename>RDEPENDS</filename> variable, the build will not fail 663 <ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'><filename>RRECOMMENDS</filename></ulink>
661 if this module is not available to include in the image. 664 and not a
665 <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink>
666 variable, the build will not fail if this module is not available
667 to include in the image.
662 </para> 668 </para>
663 </section> 669 </section>
664</chapter> 670</chapter>