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>
This commit is contained in:
Scott Rifenbark 2013-01-11 15:15:06 -08:00 committed by Richard Purdie
parent e4e2c72a40
commit 2512cbf862
1 changed files with 34 additions and 60 deletions

View File

@ -51,69 +51,43 @@
</para>
<para>
To begin with, create a minimal, custom layer from which you
can work.
See the
"<ulink url='&YOCTO_DOCS_DEV_URL;#get-your-layer-setup-for-the-build'>Get Your Layer Setup for the Build</ulink>" section
of the Yocto Project Development Manual for information.
</para>
<para>
Next comes the <filename>.bbappend</filename> file.
You create this file in your custom layer.
You also name it accordingly based on the linux-yocto recipe
you are using.
For example, if you are modifying the
<filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename>
recipe, the append file will typical be located as follows
within your custom layer:
<literallayout class='monospaced'>
To modify an existing recipe, do the following:
<orderedlist>
<listitem><para>Create a minimal, custom layer from which you
can work.
See the "<link linkend='creating-and-preparing-a-layer'>Creating and Preparing a Layer</link>"
section for some general resources.
You can also see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#get-your-layer-setup-for-the-build'>Get Your Layer Setup for the Build</ulink>" section
of the Yocto Project Development Manual for a detailed
example.</para></listitem>
<listitem><para>Create the <filename>.bbappend</filename> file.
You create this file in your custom layer.
You also name it accordingly based on the linux-yocto recipe
you are using.
For example, if you are modifying the
<filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename>
recipe, the append file will typical be located as follows
within your custom layer:
<literallayout class='monospaced'>
&lt;your-layer&gt;/recipes-kernel/linux/linux-yocto_3.4.bbappend
</literallayout>
The append file should initially contain the following text:
<literallayout class='monospaced'>
</literallayout>
The append file should initially contain the following text:
<literallayout class='monospaced'>
<ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'>FILESEXTRAPATHS</ulink> := "${THISDIR}/${PN}"
</literallayout>
The path <filename>${THISDIR}/${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename> expands
to "linux-yocto" in the current directory for this example.
If you add any new files that modify the kernel recipe, you need
to place them in your layer in the following area:
<literallayout class='monospaced'>
</literallayout>
The path <filename>${THISDIR}/${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename> expands
to "linux-yocto" in the current directory for this example.
If you add any new files that modify the kernel recipe,
you need to place them in your layer in the following area:
<literallayout class='monospaced'>
&lt;your-layer&gt;/recipes-kernel/linux/linux-yocto/
</literallayout>
<note>If you are working on a new machine Board Support Package
(BSP), be sure to refer to the
<ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>.
</note>
</para>
<para>
Original text:
<literallayout class='monospaced'>
In many cases, you can customize an existing linux-yocto recipe to meet the
needs of your project. Each release of the Yocto Project provides a few Linux
kernel recipes to choose from. To get started, prepare a layer and a bbappend
file corresponding to the recipe you wish to modify.
See [New example in Dev Manual] for instructions to create a minimal layer.
The bbappend will typical be located at the following location relative to the
layer (if modifying the linux-yocto_3.4.bb recipe):
recipes-kernel/linux/linux-yocto_3.4.bbappend
And should contain the following text initially:
FILESEXTRAPATHS := "${THISDIR}/${PN}"
The ${PN} will expand to "linux-yocto" in this example. Any new files added to
modify the recipe should then be added to the following path within the layer:
recipes-kernel/linux/linux-yocto/
NOTE: If you are working on a new machine BSP, be sure to refer to the Yocto
Project Board Support Package Developer's Guide.
</literallayout>
</literallayout>
<note>If you are working on a new machine Board Support Package
(BSP), be sure to refer to the
<ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>.
</note></para></listitem>
</orderedlist>
</para>
<section id='applying-patches'>