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

documentation/dev-manual: Fixed "Linux Yocto" term 

Throughout the manual, the kernels that are built and available through
the Yocto Project were being referenced as a "Linux Yocto kernel."
This reference is poor.  First, it placed Linux and Yocto very close
together and could upset the Linux folks.  Second, a better way would
have been to say "Yocto Linux kernel."  I have fixed by referring to
kernels that are available through the Yocto Project as
"Yocto Project kernels."

(From yocto-docs rev: 9b8319328cd4ab4ce3363001c9feeec585d9cab9)

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-07-02 10:19:10 -07:00 committed by Richard Purdie
parent 85673e5466
commit d779c83e71
5 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/dev-manual/dev-manual-bsp-appendix.xml
View File

@ -266,7 +266,7 @@
<filename>PREFERRED_VERSION_linux-yocto</filename> statement. <filename>PREFERRED_VERSION_linux-yocto</filename> statement.
This statement identifies the kernel that the BSP is going to use. This statement identifies the kernel that the BSP is going to use.
In this case, the BSP is using <filename>linux-yocto</filename>, which is the In this case, the BSP is using <filename>linux-yocto</filename>, which is the
current Linux Yocto kernel based on the Linux 3.2 release. current Yocto Project kernel based on the Linux 3.2 release.
</para> </para>
<para> <para>

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

@ -1311,7 +1311,7 @@
<title>Configuring the Kernel</title> <title>Configuring the Kernel</title>
<para> <para>
Configuring the Linux Yocto kernel consists of making sure the <filename>.config</filename> Configuring the Yocto Project kernel consists of making sure the <filename>.config</filename>
file has all the right information in it for the image you are building. file has all the right information in it for the image you are building.
You can use the <filename>menuconfig</filename> tool and configuration fragments to You can use the <filename>menuconfig</filename> tool and configuration fragments to
make sure your <filename>.config</filename> file is just how you need it. make sure your <filename>.config</filename> file is just how you need it.
@ -1404,7 +1404,7 @@
</para> </para>
<para> <para>
As part of the Linux Yocto kernel build process, the As part of the kernel build process, the
<filename>kernel_configcheck</filename> task runs. <filename>kernel_configcheck</filename> task runs.
This task validates the kernel configuration by checking the final This task validates the kernel configuration by checking the final
<filename>.config</filename> file against the input files. <filename>.config</filename> file against the input files.

16
documentation/dev-manual/dev-manual-kernel-appendix.xml
View File

@ -40,7 +40,7 @@
<link linkend='poky-extras-repo'><filename>poky-extras</filename></link> <link linkend='poky-extras-repo'><filename>poky-extras</filename></link>
Git repository placed within the source directory.</para></listitem> Git repository placed within the source directory.</para></listitem>
<listitem><para>A bare clone of the <listitem><para>A bare clone of the
<link linkend='local-kernel-files'>Linux Yocto Kernel</link> upstream Git <link linkend='local-kernel-files'>Yocto Project Kernel</link> upstream Git
repository to which you want to push your modifications. repository to which you want to push your modifications.
</para></listitem> </para></listitem>
<listitem><para>A copy of that bare clone in which you make your source <listitem><para>A copy of that bare clone in which you make your source
@ -83,14 +83,14 @@
which is where you make changes that append the kernel build recipes. which is where you make changes that append the kernel build recipes.
You edit <filename>.bbappend</filename> files to locate your You edit <filename>.bbappend</filename> files to locate your
local kernel source files and to identify the kernel being built. local kernel source files and to identify the kernel being built.
This Git repository is a gathering place for extensions to the Linux Yocto This Git repository is a gathering place for extensions to the Yocto Project
(or really any) kernel recipes that faciliate the creation and development (or really any) kernel recipes that faciliate the creation and development
of kernel features, BSPs or configurations.</para> of kernel features, BSPs or configurations.</para>
<para>See the bulleted item <para>See the bulleted item
"<link linkend='poky-extras-repo'>The "<link linkend='poky-extras-repo'>The
<filename>poky-extras</filename> Git Repository</link>" <filename>poky-extras</filename> Git Repository</link>"
for information on how to get these files.</para></listitem> for information on how to get these files.</para></listitem>
<listitem><para><emphasis>Bare Clone of the Linux Yocto kernel:</emphasis> <listitem><para><emphasis>Bare Clone of the Yocto Project kernel:</emphasis>
This bare Git repository tracks the upstream Git repository of the Linux This bare Git repository tracks the upstream Git repository of the Linux
Yocto kernel source code you are changing. Yocto kernel source code you are changing.
When you modify the kernel you must work through a bare clone. When you modify the kernel you must work through a bare clone.
@ -100,15 +100,15 @@
<filename>poky-extras</filename> repository points to the bare clone <filename>poky-extras</filename> repository points to the bare clone
so that the build process can locate the locally changed source files.</para> so that the build process can locate the locally changed source files.</para>
<para>See the bulleted item <para>See the bulleted item
"<link linkend='local-kernel-files'>Linux Yocto Kernel</link>" "<link linkend='local-kernel-files'>Yocto Project Kernel</link>"
for information on how to set up the bare clone. for information on how to set up the bare clone.
</para></listitem> </para></listitem>
<listitem><para><emphasis>Copy of the Linux Yocto Kernel Bare Clone:</emphasis> <listitem><para><emphasis>Copy of the Yocto Project Kernel Bare Clone:</emphasis>
This Git repository contains the actual source files that you modify. This Git repository contains the actual source files that you modify.
Any changes you make to files in this location need to ultimately be pushed Any changes you make to files in this location need to ultimately be pushed
to the bare clone using the <filename>git push</filename> command.</para> to the bare clone using the <filename>git push</filename> command.</para>
<para>See the bulleted item <para>See the bulleted item
"<link linkend='local-kernel-files'>Linux Yocto Kernel</link>" "<link linkend='local-kernel-files'>Yocto Project Kernel</link>"
for information on how to set up the bare clone. for information on how to set up the bare clone.
<note>Typically, Git workflows follow a scheme where changes made to a local area <note>Typically, Git workflows follow a scheme where changes made to a local area
are pulled into a Git repository. are pulled into a Git repository.
@ -192,7 +192,7 @@
Thus, you need to create a bare clone of that kernel and then make a copy of the Thus, you need to create a bare clone of that kernel and then make a copy of the
bare clone. bare clone.
See the bulleted item See the bulleted item
"<link linkend='local-kernel-files'>Linux Yocto Kernel</link>" "<link linkend='local-kernel-files'>Yocto Project Kernel</link>"
for information on how to do that. for information on how to do that.
</para> </para>
@ -708,7 +708,7 @@
<para> <para>
Once you save the selection, the <filename>.config</filename> configuration file Once you save the selection, the <filename>.config</filename> configuration file
is updated. is updated.
This is the file that the build system uses to configure the Linux Yocto kernel This is the file that the build system uses to configure the Yocto Project kernel
when it is built. when it is built.
You can find and examine this file in the build directory. You can find and examine this file in the build directory.
This example uses the following: This example uses the following:

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

@ -214,7 +214,7 @@
<title><anchor id='kernel-spot' />Modifying the Kernel</title> <title><anchor id='kernel-spot' />Modifying the Kernel</title>
<para> <para>
Kernel modification involves changing the Linux Yocto kernel, which could involve changing Kernel modification involves changing the Yocto Project kernel, which could involve changing
configuration options as well as adding new kernel recipes. configuration options as well as adding new kernel recipes.
Configuration changes can be added in the form of configuration fragments, while recipe Configuration changes can be added in the form of configuration fragments, while recipe
modification comes through the kernel's <filename>recipes-kernel</filename> area modification comes through the kernel's <filename>recipes-kernel</filename> area
@ -222,8 +222,8 @@
</para> </para>
<para> <para>
The remainder of this section presents a high-level overview of the Linux Yocto The remainder of this section presents a high-level overview of the Yocto Project
kernel architecture and the steps to modify the Linux Yocto kernel. kernel architecture and the steps to modify the kernel.
For a complete discussion of the kernel, see For a complete discussion of the kernel, see
<ulink url='&YOCTO_DOCS_KERNEL_URL;'> <ulink url='&YOCTO_DOCS_KERNEL_URL;'>
The Yocto Project Kernel Architecture and Use Manual</ulink>. The Yocto Project Kernel Architecture and Use Manual</ulink>.
@ -244,7 +244,7 @@
</para> </para>
<para> <para>
You can find a web interface to the Linux Yocto kernel source repositories at You can find a web interface to the Yocto Project kernel source repositories at
<ulink url='&YOCTO_GIT_URL;'></ulink>. <ulink url='&YOCTO_GIT_URL;'></ulink>.
If you look at the interface, you will see to the left a grouping of If you look at the interface, you will see to the left a grouping of
Git repositories titled "Yocto Linux Kernel." Git repositories titled "Yocto Linux Kernel."
@ -252,17 +252,17 @@
the Yocto Project: the Yocto Project:
<itemizedlist> <itemizedlist>
<listitem><para><emphasis><filename>linux-yocto-2.6.34</filename></emphasis> - The <listitem><para><emphasis><filename>linux-yocto-2.6.34</filename></emphasis> - The
stable Linux Yocto kernel that is based on the Linux 2.6.34 release.</para></listitem> stable Yocto Project kernel that is based on the Linux 2.6.34 released kernel.</para></listitem>
<listitem><para><emphasis><filename>linux-yocto-2.6.37</filename></emphasis> - The <listitem><para><emphasis><filename>linux-yocto-2.6.37</filename></emphasis> - The
stable Linux Yocto kernel that is based on the Linux 2.6.37 release.</para></listitem> stable Yocto Project kernel that is based on the Linux 2.6.37 released kernel.</para></listitem>
<listitem><para><emphasis><filename>linux-yocto-3.0</filename></emphasis> - The stable <listitem><para><emphasis><filename>linux-yocto-3.0</filename></emphasis> - The stable
Linux Yocto kernel that is based on the Linux 3.0 release.</para></listitem> Yocto Project kernel that is based on the Linux 3.0 released kernel.</para></listitem>
<listitem><para><emphasis><filename>linux-yocto-3.0-1.1.x</filename></emphasis> - The <listitem><para><emphasis><filename>linux-yocto-3.0-1.1.x</filename></emphasis> - The
stable Linux Yocto kernel to use with the Yocto Project Release 1.1.x. This kernel stable Yocto Project kernel to use with the Yocto Project Release 1.1.x. This kernel
is based on the Linux 3.0 release</para></listitem> is based on the Linux 3.0 released kernel.</para></listitem>
<listitem><para><emphasis><filename>linux-yocto-3.2</filename></emphasis> - The <listitem><para><emphasis><filename>linux-yocto-3.2</filename></emphasis> - The
stable Linux Yocto kernel to use with the Yocto Project Release 1.2. This kernel stable Yocto Project kernel to use with the Yocto Project Release 1.2. This kernel
is based on the Linux 3.2 release</para></listitem> is based on the Linux 3.2 released kernel.</para></listitem>
<listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development <listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development
kernel based on the latest upstream release candidate available.</para></listitem> kernel based on the latest upstream release candidate available.</para></listitem>
</itemizedlist> </itemizedlist>
@ -304,8 +304,8 @@
</para> </para>
<note> <note>
Keep in mind the figure does not take into account all the supported Linux Yocto Keep in mind the figure does not take into account all the supported Yocto
kernel types, but rather shows a single generic kernel just for conceptual purposes. Project kernel types, but rather shows a single generic kernel just for conceptual purposes.
Also keep in mind that this structure represents the Yocto Project source repositories Also keep in mind that this structure represents the Yocto Project source repositories
that are either pulled from during the build or established on the host development system that are either pulled from during the build or established on the host development system
prior to the build by either cloning a particular kernel's Git repository or by prior to the build by either cloning a particular kernel's Git repository or by
@ -324,13 +324,13 @@
<para> <para>
You make kernel source code available on your host development system by using You make kernel source code available on your host development system by using
Git to create a bare clone of the Linux Yocto kernel Git repository Git to create a bare clone of the Yocto Project kernel Git repository
in which you are interested. in which you are interested.
Then, you use Git again to clone a copy of that bare clone. Then, you use Git again to clone a copy of that bare clone.
This copy represents the directory structure on your host system that is particular This copy represents the directory structure on your host system that is particular
to the kernel you want. to the kernel you want.
These are the files you actually modify to change the kernel. These are the files you actually modify to change the kernel.
See the <link linkend='local-kernel-files'>Linux Yocto Kernel</link> item earlier 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 in this manual for an example of how to set up the kernel source directory
structure on your host system. structure on your host system.
</para> </para>
@ -425,9 +425,9 @@
<note>While it is certainly possible to modify the kernel without involving <note>While it is certainly possible to modify the kernel without involving
a local Git repository, the suggested workflow for kernel modification a local Git repository, the suggested workflow for kernel modification
using the Yocto Project does use a Git repository.</note></para></listitem> using the Yocto Project does use a Git repository.</note></para></listitem>
<listitem><para><emphasis>Establish a local copy of the Linux Yocto kernel files on your <listitem><para><emphasis>Establish a local copy of the Yocto Project kernel files on your
system</emphasis>: In order to make modifications to the kernel you need two things: system</emphasis>: In order to make modifications to the kernel you need two things:
a bare clone of the Linux Yocto kernel you are modifying and a bare clone of the Yocto Project kernel you are modifying and
a copy of that bare clone. a copy of that bare clone.
The bare clone is required by the build process and is the area to which you The bare clone is required by the build process and is the area to which you
push your kernel source changes (pulling does not work with bare clones). push your kernel source changes (pulling does not work with bare clones).
@ -435,7 +435,7 @@
source files. source files.
You make your changes to the files in this copy of the bare clone. You make your changes to the files in this copy of the bare clone.
For information on how to set these two items up, see the bulleted item For information on how to set these two items up, see the bulleted item
"<link linkend='local-kernel-files'>Linux Yocto Kernel</link>" "<link linkend='local-kernel-files'>Yocto Project Kernel</link>"
earlier in this manual.</para></listitem> 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
@ -506,8 +506,8 @@
which allows you to distribute the layer.</para></listitem> which allows you to distribute the layer.</para></listitem>
<listitem><para><emphasis>If applicable, share your in-tree changes</emphasis>: <listitem><para><emphasis>If applicable, share your in-tree changes</emphasis>:
If the changes you made If the changes you made
are suited for all Linux Yocto users, you might want to send them on for inclusion are suited for all Yocto Project kernel users, you might want to send them on
into the Linux Yocto Git repository. for inclusion into the upstream kernel's Git repository.
If the changes are accepted, the Yocto Project Maintainer pulls them into If the changes are accepted, the Yocto Project Maintainer pulls them into
the master branch of the kernel tree. the master branch of the kernel tree.
Doing so makes them available to everyone using the kernel.</para></listitem> Doing so makes them available to everyone using the kernel.</para></listitem>
@ -522,7 +522,7 @@
<para> <para>
Application development involves creation of an application that you want to be able Application development involves creation of an application that you want to be able
to run on your target hardware, which is running a Linux Yocto image. to run on your target hardware, which is running a Yocto Project kernel image.
The Yocto Project provides an Application Development Toolkit (ADT) that The Yocto Project provides an Application Development Toolkit (ADT) that
facilitates quick development and integration of your application into its run-time environment. facilitates quick development and integration of your application into its run-time environment.
Using the ADT you can employ cross-development toolchains designed for your target hardware Using the ADT you can employ cross-development toolchains designed for your target hardware
@ -567,7 +567,7 @@
"<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and
"<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both
in the Yocto Project Quick Start for requirements.</para></listitem> in the Yocto Project Quick Start for requirements.</para></listitem>
<listitem><para><emphasis>Secure the Linux Yocto Kernel Target Image</emphasis>: <listitem><para><emphasis>Secure the Yocto Project Kernel Target Image</emphasis>:
You must have a target kernel image that has been built using the OpenEmbeded You must have a target kernel image that has been built using the OpenEmbeded
build system.</para> build system.</para>
<para>Depending on whether the Yocto Project has a pre-built image that matches your target <para>Depending on whether the Yocto Project has a pre-built image that matches your target
@ -591,7 +591,7 @@
See the See the
"<link linkend='kernel-modification-workflow'>Kernel Modification Workflow</link>" "<link linkend='kernel-modification-workflow'>Kernel Modification Workflow</link>"
section earlier in this manual for information on how to create a modified section earlier in this manual for information on how to create a modified
Linux Yocto kernel.</para></listitem> Yocto Project kernel.</para></listitem>
</itemizedlist></para> </itemizedlist></para>
<para>For information on pre-built kernel image naming schemes for images <para>For information on pre-built kernel image naming schemes for images
that can run on the QEMU emulator, see the that can run on the QEMU emulator, see the

12
documentation/dev-manual/dev-manual-start.xml
View File

@ -116,13 +116,13 @@
wiki page</ulink>, which describes how to create both <filename>poky</filename> wiki page</ulink>, which describes how to create both <filename>poky</filename>
and <filename>meta-intel</filename> Git repositories.</para></listitem> and <filename>meta-intel</filename> Git repositories.</para></listitem>
</itemizedlist></para></listitem> </itemizedlist></para></listitem>
<listitem id='local-kernel-files'><para><emphasis>Linux Yocto Kernel:</emphasis> <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis>
If you are going to be making modifications to a supported Linux Yocto kernel, you If you are going to be making modifications to a supported Yocto Project kernel, you
need to establish local copies of the source. need to establish local copies of the source.
You can find Git repositories of supported Linux Yocto Kernels organized under You can find Git repositories of supported Yocto Project Kernels organized under
"Yocto Linux Kernel" in the Yocto Project Source Repositories at "Yocto Project Linux Kernel" in the Yocto Project Source Repositories at
<ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para>
<para>This setup involves creating a bare clone of the Linux Yocto kernel and then <para>This setup involves creating a bare clone of the Yocto Project kernel and then
copying that cloned repository. copying that cloned repository.
You can create the bare clone and the copy of the bare clone anywhere you like. You can create the bare clone and the copy of the bare clone anywhere you like.
For simplicity, it is recommended that you create these structures outside of the For simplicity, it is recommended that you create these structures outside of the
@ -130,7 +130,7 @@
<para>As an example, the following transcript shows how to create the bare clone <para>As an example, the following transcript shows how to create the bare clone
of the <filename>linux-yocto-3.2</filename> kernel and then create a copy of of the <filename>linux-yocto-3.2</filename> kernel and then create a copy of
that clone. that clone.
<note>When you have a local Linux Yocto kernel Git repository, you can <note>When you have a local Yocto Project kernel Git repository, you can
reference that repository rather than the upstream Git repository as reference that repository rather than the upstream Git repository as
part of the <filename>clone</filename> command. part of the <filename>clone</filename> command.
Doing so can speed up the process.</note></para> Doing so can speed up the process.</note></para>