summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-01-11 23:27:09 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-16 15:59:19 (GMT)
commit719824f9ce457f40f5f2fc45d68379755cf27b3e (patch)
tree3c4ea38589e8b04e6c9592b92ccbf0094949bc52 /documentation/kernel-dev
parent2512cbf862ca371223506da710bb8aa1a048ad99 (diff)
downloadpoky-719824f9ce457f40f5f2fc45d68379755cf27b3e.tar.gz
kernel-dev: Created new "Creating the Append File" section.
fixed up the organization of how you modify a recipe. It can consist of three things. I have created a new subsection for the first item, creating the append file. (From yocto-docs rev: a8342ccf18c0406669f6983da31d38603d87921e) 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-common.xml82
1 files changed, 47 insertions, 35 deletions
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index 787f341..4cceb93 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -51,44 +51,56 @@
51 </para> 51 </para>
52 52
53 <para> 53 <para>
54 To modify an existing recipe, do the following: 54 Modifying an existing recipe can consist of the following:
55 <orderedlist> 55 <itemizedlist>
56 <listitem><para>Create a minimal, custom layer from which you 56 <listitem><para>Creating the append file</para></listitem>
57 can work. 57 <listitem><para>Applying patches</para></listitem>
58 See the "<link linkend='creating-and-preparing-a-layer'>Creating and Preparing a Layer</link>" 58 <listitem><para>Changing the configuration</para></listitem>
59 section for some general resources. 59 </itemizedlist>
60 You can also see the 60 </para>
61 "<ulink url='&YOCTO_DOCS_DEV_URL;#get-your-layer-setup-for-the-build'>Get Your Layer Setup for the Build</ulink>" section 61
62 of the Yocto Project Development Manual for a detailed 62 <para>
63 example.</para></listitem> 63 Before modifying an existing recipe, be sure that you have created
64 <listitem><para>Create the <filename>.bbappend</filename> file. 64 a minimal, custom layer from which you can work.
65 You create this file in your custom layer. 65 See the "<link linkend='creating-and-preparing-a-layer'>Creating and Preparing a Layer</link>"
66 You also name it accordingly based on the linux-yocto recipe 66 section for some general resources.
67 you are using. 67 You can also see the
68 For example, if you are modifying the 68 "<ulink url='&YOCTO_DOCS_DEV_URL;#get-your-layer-setup-for-the-build'>Get Your Layer Setup for the Build</ulink>" section
69 <filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename> 69 of the Yocto Project Development Manual for a detailed
70 recipe, the append file will typical be located as follows 70 example.
71 within your custom layer: 71 </para>
72 <literallayout class='monospaced'> 72
73 <section id='creating-the-append-file'>
74 <title>Creating the Append File</title>
75
76 <para>
77 You create this file in your custom layer.
78 You also name it accordingly based on the linux-yocto recipe
79 you are using.
80 For example, if you are modifying the
81 <filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename>
82 recipe, the append file will typical be located as follows
83 within your custom layer:
84 <literallayout class='monospaced'>
73 &lt;your-layer&gt;/recipes-kernel/linux/linux-yocto_3.4.bbappend 85 &lt;your-layer&gt;/recipes-kernel/linux/linux-yocto_3.4.bbappend
74 </literallayout> 86 </literallayout>
75 The append file should initially contain the following text: 87 The append file should initially contain the following text:
76 <literallayout class='monospaced'> 88 <literallayout class='monospaced'>
77 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'>FILESEXTRAPATHS</ulink> := "${THISDIR}/${PN}" 89 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'>FILESEXTRAPATHS</ulink> := "${THISDIR}/${PN}"
78 </literallayout> 90 </literallayout>
79 The path <filename>${THISDIR}/${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename> expands 91 The path <filename>${THISDIR}/${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename> expands
80 to "linux-yocto" in the current directory for this example. 92 to "linux-yocto" in the current directory for this example.
81 If you add any new files that modify the kernel recipe, 93 If you add any new files that modify the kernel recipe,
82 you need to place them in your layer in the following area: 94 you need to place them in your layer in the following area:
83 <literallayout class='monospaced'> 95 <literallayout class='monospaced'>
84 &lt;your-layer&gt;/recipes-kernel/linux/linux-yocto/ 96 &lt;your-layer&gt;/recipes-kernel/linux/linux-yocto/
85 </literallayout> 97 </literallayout>
86 <note>If you are working on a new machine Board Support Package 98 <note>If you are working on a new machine Board Support Package
87 (BSP), be sure to refer to the 99 (BSP), be sure to refer to the
88 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. 100 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>.
89 </note></para></listitem> 101 </note>
90 </orderedlist> 102 </para>
91 </para> 103 </section>
92 104
93 <section id='applying-patches'> 105 <section id='applying-patches'>
94 <title>Applying Patches</title> 106 <title>Applying Patches</title>