diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-01-11 15:15:06 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-01-16 15:59:18 +0000 |
commit | 2512cbf862ca371223506da710bb8aa1a048ad99 (patch) | |
tree | a98e04eab2d85f4cd489d365748513b33a13df87 /documentation | |
parent | e4e2c72a40dbc41c19939f0a8bea285ef05ddf89 (diff) | |
download | poky-2512cbf862ca371223506da710bb8aa1a048ad99.tar.gz |
kernel-dev: Edits to "Modifying an Existing Recipe"
Second pass through this section. Also removed the original text.
Switching to numbered list.
(From yocto-docs rev: 7978c5acd4776e6ade7c0ee34c6f7ab58eeb2bb9)
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.xml | 94 |
1 files changed, 34 insertions, 60 deletions
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml index 9a55d7f555..787f3411b7 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml | |||
@@ -51,69 +51,43 @@ | |||
51 | </para> | 51 | </para> |
52 | 52 | ||
53 | <para> | 53 | <para> |
54 | To begin with, create a minimal, custom layer from which you | 54 | To modify an existing recipe, do the following: |
55 | can work. | 55 | <orderedlist> |
56 | See the | 56 | <listitem><para>Create a minimal, custom layer from which you |
57 | "<ulink url='&YOCTO_DOCS_DEV_URL;#get-your-layer-setup-for-the-build'>Get Your Layer Setup for the Build</ulink>" section | 57 | can work. |
58 | of the Yocto Project Development Manual for information. | 58 | See the "<link linkend='creating-and-preparing-a-layer'>Creating and Preparing a Layer</link>" |
59 | </para> | 59 | section for some general resources. |
60 | 60 | You can also see the | |
61 | <para> | 61 | "<ulink url='&YOCTO_DOCS_DEV_URL;#get-your-layer-setup-for-the-build'>Get Your Layer Setup for the Build</ulink>" section |
62 | Next comes the <filename>.bbappend</filename> file. | 62 | of the Yocto Project Development Manual for a detailed |
63 | You create this file in your custom layer. | 63 | example.</para></listitem> |
64 | You also name it accordingly based on the linux-yocto recipe | 64 | <listitem><para>Create the <filename>.bbappend</filename> file. |
65 | you are using. | 65 | You create this file in your custom layer. |
66 | For example, if you are modifying the | 66 | You also name it accordingly based on the linux-yocto recipe |
67 | <filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename> | 67 | you are using. |
68 | recipe, the append file will typical be located as follows | 68 | For example, if you are modifying the |
69 | within your custom layer: | 69 | <filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename> |
70 | <literallayout class='monospaced'> | 70 | recipe, the append file will typical be located as follows |
71 | within your custom layer: | ||
72 | <literallayout class='monospaced'> | ||
71 | <your-layer>/recipes-kernel/linux/linux-yocto_3.4.bbappend | 73 | <your-layer>/recipes-kernel/linux/linux-yocto_3.4.bbappend |
72 | </literallayout> | 74 | </literallayout> |
73 | The append file should initially contain the following text: | 75 | The append file should initially contain the following text: |
74 | <literallayout class='monospaced'> | 76 | <literallayout class='monospaced'> |
75 | <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'>FILESEXTRAPATHS</ulink> := "${THISDIR}/${PN}" | 77 | <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'>FILESEXTRAPATHS</ulink> := "${THISDIR}/${PN}" |
76 | </literallayout> | 78 | </literallayout> |
77 | The path <filename>${THISDIR}/${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename> expands | 79 | The path <filename>${THISDIR}/${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename> expands |
78 | to "linux-yocto" in the current directory for this example. | 80 | to "linux-yocto" in the current directory for this example. |
79 | If you add any new files that modify the kernel recipe, you need | 81 | If you add any new files that modify the kernel recipe, |
80 | to place them in your layer in the following area: | 82 | you need to place them in your layer in the following area: |
81 | <literallayout class='monospaced'> | 83 | <literallayout class='monospaced'> |
82 | <your-layer>/recipes-kernel/linux/linux-yocto/ | 84 | <your-layer>/recipes-kernel/linux/linux-yocto/ |
83 | </literallayout> | 85 | </literallayout> |
84 | <note>If you are working on a new machine Board Support Package | 86 | <note>If you are working on a new machine Board Support Package |
85 | (BSP), be sure to refer to the | 87 | (BSP), be sure to refer to the |
86 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. | 88 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. |
87 | </note> | 89 | </note></para></listitem> |
88 | </para> | 90 | </orderedlist> |
89 | |||
90 | <para> | ||
91 | Original text: | ||
92 | <literallayout class='monospaced'> | ||
93 | In many cases, you can customize an existing linux-yocto recipe to meet the | ||
94 | needs of your project. Each release of the Yocto Project provides a few Linux | ||
95 | kernel recipes to choose from. To get started, prepare a layer and a bbappend | ||
96 | file corresponding to the recipe you wish to modify. | ||
97 | |||
98 | See [New example in Dev Manual] for instructions to create a minimal layer. | ||
99 | |||
100 | The bbappend will typical be located at the following location relative to the | ||
101 | layer (if modifying the linux-yocto_3.4.bb recipe): | ||
102 | |||
103 | recipes-kernel/linux/linux-yocto_3.4.bbappend | ||
104 | |||
105 | And should contain the following text initially: | ||
106 | |||
107 | FILESEXTRAPATHS := "${THISDIR}/${PN}" | ||
108 | |||
109 | The ${PN} will expand to "linux-yocto" in this example. Any new files added to | ||
110 | modify the recipe should then be added to the following path within the layer: | ||
111 | |||
112 | recipes-kernel/linux/linux-yocto/ | ||
113 | |||
114 | NOTE: If you are working on a new machine BSP, be sure to refer to the Yocto | ||
115 | Project Board Support Package Developer's Guide. | ||
116 | </literallayout> | ||
117 | </para> | 91 | </para> |
118 | 92 | ||
119 | <section id='applying-patches'> | 93 | <section id='applying-patches'> |