sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

documentation: dev-manual, bsp-guide, kernel-manual - kernel workflow 

The kernel workflow section was re-written to reflect that the
kernel appendix has been removed.  Also, changes to the flow in
general no longer make reference to the bare clone and the copy
of the bare clone as a method used to modify the kernel.

Many links were modified in other manuals as well.

(From yocto-docs rev: 38adbcb00d4305029cfa94e5ef047da41823f021)

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 2012-10-09 06:32:34 -07:00 committed by Richard Purdie
parent 8461d4ad85
commit 0bd73012ee
5 changed files with 52 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
documentation/bsp-guide/bsp.xml
View File

@ -618,10 +618,6 @@
<filename>meta</filename> branch for your BSP. <filename>meta</filename> branch for your BSP.
The configuration options will likely end up in that location anyway if the BSP gets The configuration options will likely end up in that location anyway if the BSP gets
added to the Yocto Project. added to the Yocto Project.
<!-- For a better understanding of working with a local clone of the kernel repository
and a local bare clone of the kernel, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#modifying-the-kernel-source-code'>Modifying the Kernel
Source Code</ulink>" section also in the Yocto Project Development Manual. -->
</para> </para>
<para> <para>

12
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -1608,8 +1608,6 @@
Kernel modification involves changing or adding configurations to an existing kernel, Kernel modification involves changing or adding configurations to an existing kernel,
changing or adding recipes to the kernel that are needed to support specific hardware features, changing or adding recipes to the kernel that are needed to support specific hardware features,
or even altering the source code itself. or even altering the source code itself.
This appendix presents simple examples that modify the kernel source code,
change the kernel configuration, and add a kernel source recipe.
<note> <note>
You can use the <filename>yocto-kernel</filename> script You can use the <filename>yocto-kernel</filename> script
found in the <link linkend='source-directory'>Source Directory</link> found in the <link linkend='source-directory'>Source Directory</link>
@ -1627,6 +1625,16 @@
console. console.
</para> </para>
<section id='finding-the-kernel-source-files'>
<title>Finding the Kernel Source Files</title>
<para>
Describe how to find the source files in the build area.
We are not assuming they are using their own kernel tree.
</para>
</section>
<section id='understanding-the-files-you-need'> <section id='understanding-the-files-you-need'>
<title>Understanding the Files You Need</title> <title>Understanding the Files You Need</title>

157
documentation/dev-manual/dev-manual-model.xml
View File

@ -8,7 +8,8 @@
<para> <para>
Many development models exist for which you can use the Yocto Project. Many development models exist for which you can use the Yocto Project.
This chapter overviews the following methods: This chapter overviews simple methods that use tools provided by the
Yocto Project:
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>System Development:</emphasis> <listitem><para><emphasis>System Development:</emphasis>
System Development covers Board Support Package (BSP) development and kernel System Development covers Board Support Package (BSP) development and kernel
@ -322,8 +323,8 @@
</note> </note>
<para> <para>
Storage of all the available kernel source code is one thing, while representing the Upstream storage of all the available kernel source code is one thing, while
code on your host development system is another. representing and using the code on your host development system is another.
Conceptually, you can think of the kernel source repositories as all the Conceptually, you can think of the kernel source repositories as all the
source files necessary for all the supported kernels. source files necessary for all the supported kernels.
As a developer, you are just interested in the source files for the kernel on As a developer, you are just interested in the source files for the kernel on
@ -332,39 +333,14 @@
</para> </para>
<para> <para>
You make kernel source code available on your host development system by using Kernel source code is available on your host system a couple of different
Git to create a bare clone of the Yocto Project kernel Git repository ways.
in which you are interested. If you are working in the kernel all the time, you probably would want
Then, you use Git again to clone a copy of that bare clone. to set up your own local Git repository of the kernel tree.
This copy represents the directory structure on your host system that is particular If you just need to make some patches to the kernel, you can get at
to the kernel you want. temporary kernel source files extracted and used during the OpenEmbedded
The files in the copy of the bare clone are the files you actually modify build system.
to change the kernel. We will just talk about working with the temporary source code.
See the <link linkend='local-kernel-files'>Yocto Project Kernel</link> item earlier
in this manual for an example of how to set up the kernel source directory
structure on your host system.
</para>
<para>
This next figure illustrates how the kernel source files might be arranged on
your host system.
</para>
<para>
<imagedata fileref="figures/kernel-overview-3-generic.png"
width="6in" depth="4in" align="center" scale="100" />
</para>
<para>
In the previous figure, the file structure on the left represents the bare clone
set up to track the Yocto Project kernel Git repository.
The structure on the right represents the copy of the bare clone.
When you make modifcations to the kernel source code, this is the area in which
you work.
Once you make corrections, you must use Git to push the committed changes to the
bare clone.
<!-- The example in <xref linkend='modifying-the-kernel-source-code'>
Modifying the Kernel Source Code</xref> provides a detailed example. -->
</para> </para>
<para> <para>
@ -407,7 +383,7 @@
<para> <para>
<imagedata fileref="figures/kernel-dev-flow.png" <imagedata fileref="figures/kernel-dev-flow.png"
width="6in" depth="7.5in" align="center" scalefit="1" /> width="6in" depth="5in" align="center" scalefit="1" />
</para> </para>
<para> <para>
@ -424,43 +400,39 @@
For information on how to get these files, see the bulleted item For information on how to get these files, see the bulleted item
"<link linkend='local-yp-release'>Yocto Project Release</link>" earlier in this manual. "<link linkend='local-yp-release'>Yocto Project Release</link>" earlier in this manual.
</para></listitem> </para></listitem>
<listitem><para><emphasis>Set up a local copy of the <filename>poky-extras</filename> Git <listitem><para><emphasis>Establish the temporary kernel source files</emphasis>:
repository</emphasis>: This local repository is the area for your configuration Temporary kernel source files are kept in the Build Directory created by the
fragments, new kernel recipes, and the kernel <filename>.bbappend</filename> OpenEmbedded build system when you run BitBake.
file used during the build. If you have never built the kernel you are interested in, you need to run
It is good practice to set this repository up inside your local an initial build to establish local kernel source files.</para>
<link linkend='source-directory'>Source Directory</link>. <para>If you are building an image for the first time, you need to get the build
For information on how to get these files, see the bulleted item environment ready by sourcing
"<link linkend='poky-extras-repo'>The <filename>poky-extras</filename> Git Repository</link>" the environment setup script.
earlier in this manual. You also need to be sure two key configuration files
<note>While it is certainly possible to modify the kernel without involving (<filename>local.conf</filename> and <filename>bblayers.conf</filename>)
a local Git repository, the suggested workflow for kernel modification are configured appropriately.</para>
using the Yocto Project does use a Git repository.</note></para></listitem> <para>The entire process for building an image is overviewed in the
<listitem><para><emphasis>Establish a local copy of the Yocto Project kernel files on your "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
system</emphasis>: In order to make modifications to the kernel you need two things: section of the Yocto Project Quick Start.
a bare clone of the Yocto Project kernel you are modifying and You might want to reference this information.
a copy of that bare clone. You can find more information on BitBake in the user manual, which is found in the
The bare clone is required by the build process and is the area to which you <filename>bitbake/doc/manual</filename> directory of the
push your kernel source changes (pulling does not work with bare clones). <link linkend='source-directory'>Source Directory</link>.</para>
The copy of the bare clone is a local Git repository that contains all the kernel's <para>The build process supports several types of images to satisfy different needs.
source files. See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in
You make your changes to the files in this copy of the bare clone. the Yocto Project Reference Manual for information on supported images.
For information on how to set these two items up, see the bulleted item </para></listitem>
"<link linkend='local-kernel-files'>Yocto Project Kernel</link>"
earlier in this manual.</para></listitem>
<listitem><para><emphasis>Make changes to the kernel source code if <listitem><para><emphasis>Make changes to the kernel source code if
applicable</emphasis>: Modifying the kernel does not always mean directly applicable</emphasis>: Modifying the kernel does not always mean directly
changing source files. changing source files.
However, if you have to do this, you make the changes in the local However, if you have to do this, you make the changes to the files in the
Git repository you set up to hold the source files (i.e. the copy of the Build directory.</para></listitem>
bare clone).
Once the changes are made, you need to use Git commands to commit the changes
and then push them to the bare clone.</para></listitem>
<listitem><para><emphasis>Make kernel configuration changes <listitem><para><emphasis>Make kernel configuration changes
if applicable</emphasis>: if applicable</emphasis>:
If your situation calls for changing the kernel's configuration, you can If your situation calls for changing the kernel's configuration, you can
use <filename>menuconfig</filename> use the <filename>yocto-kernel</filename> script or <filename>menuconfig</filename>
to enable and disable kernel configurations. to enable and disable kernel configurations.
Using the script lets you interactively set up kernel configurations.
Using <filename>menuconfig</filename> allows you to interactively develop and test the Using <filename>menuconfig</filename> allows you to interactively develop and test the
configuration changes you are making to the kernel. configuration changes you are making to the kernel.
When saved, changes using <filename>menuconfig</filename> update the kernel's When saved, changes using <filename>menuconfig</filename> update the kernel's
@ -476,55 +448,8 @@
<filename>.config</filename> file against a saved original and gather those <filename>.config</filename> file against a saved original and gather those
changes into a config fragment to be referenced from within the kernel's changes into a config fragment to be referenced from within the kernel's
<filename>.bbappend</filename> file.</para></listitem> <filename>.bbappend</filename> file.</para></listitem>
<listitem><para><emphasis>Add or extend kernel recipes if applicable</emphasis>: <listitem><para><emphasis>Rebuild the kernel image with your changes</emphasis>:
The standard Rebuilding the kernel image applies your changes.</para></listitem>
layer structure organizes recipe files inside the
<filename>meta-kernel-dev</filename> layer that is within the local
<filename>poky-extras</filename> Git repository.
If you need to add new kernel recipes, you add them within this layer.
Also within this area, you will find the <filename>.bbappend</filename>
file that appends information to the kernel's recipe file used during the
build.
</para></listitem>
<listitem><para><emphasis>Prepare for the build</emphasis>: Once you have made all the
changes to your kernel (configurations, source code changes, recipe additions,
or recipe changes), there remains a few things
you need to do in order for the build system to create your image.
If you have not done so, you need to get the build environment ready by sourcing
the environment setup script described earlier.
You also need to be sure two key configuration files
(<filename>local.conf</filename> and <filename>bblayers.conf</filename>)
are configured appropriately.</para>
<para>The entire process for building an image is overviewed in the
"<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
section of the Yocto Project Quick Start.
You might want to reference this information.
Also, you should look at the detailed examples found in the appendices at
at the end of this manual.</para></listitem>
<listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded
build system uses the BitBake
tool to build images based on the type of image you want to create.
You can find more information on BitBake in the user manual, which is found in the
<filename>bitbake/doc/manual</filename> directory of the
<link linkend='source-directory'>Source Directory</link>.</para>
<para>The build process supports several types of images to satisfy different needs.
See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in
the Yocto Project Reference Manual for information on supported images.</para></listitem>
<listitem><para><emphasis>Make your configuration changes available
in the kernel layer</emphasis>: Up to this point, all the configuration changes to the
kernel have been done and tested iteratively.
Once they are tested and ready to go, you can move them into the kernel layer,
which allows you to distribute the layer.</para></listitem>
<listitem><para><emphasis>If applicable, share your in-tree changes</emphasis>:
If the changes you made
are suited for all Yocto Project kernel users, you might want to send them on
for inclusion into the upstream kernel's Git repository.
If the changes are accepted, the Yocto Project Maintainer pulls them into
the master branch of the kernel tree.
Doing so makes them available to everyone using the kernel.</para>
<para>For information on how to submit a change to the Yocto Project, see the
"<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" section
earlier in this manual.</para></listitem>
</orderedlist> </orderedlist>
</para> </para>
</section> </section>

BIN
documentation/dev-manual/figures/kernel-dev-flow.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 44 KiB

2
documentation/kernel-manual/kernel-doc-intro.xml
View File

@ -55,7 +55,7 @@
"<ulink url='&YOCTO_DOCS_DEV_URL;#kernel-modification-workflow'>Kernel Modification Workflow</ulink>" "<ulink url='&YOCTO_DOCS_DEV_URL;#kernel-modification-workflow'>Kernel Modification Workflow</ulink>"
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
"<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-kernel-appendix'>Kernel Modification Example</ulink>"</para></listitem> "<ulink url='&YOCTO_DOCS_DEV_URL;#patching-the-kernel'>Patching the Kernel</ulink>"</para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>