documentation/dev-manual/dev-manual-kernel-appendix.xml: edits to example

Poor flow for the config_smp example.  Upon reading this example
it did not stand well on its own.  I added some text, albeit
redundant but necessary I felt, so that the example would stand on
its own.

(From yocto-docs rev: 1677a873e9bd1124a5ff0234edc1ee05938c19b0)

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-01-24 21:25:11 -06:00 committed by Richard Purdie
parent 68b55c1e85
commit b5a4e78df5
1 changed files with 82 additions and 34 deletions

View File

@ -248,8 +248,8 @@
of cores your machine supports and set <filename>PARALLEL_MAKE</filename> to one and of cores your machine supports and set <filename>PARALLEL_MAKE</filename> to one and
a half times the number of cores your machine supports. a half times the number of cores your machine supports.
</note> </note>
The following two commands build the default <filename>qemux86</filename> image and The following two commands <filename>source</filename> the build environment setup script
<filename>source</filename> build environment setup script. and build the default <filename>qemux86</filename> image.
If necessary, the script creates the build directory: If necessary, the script creates the build directory:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ cd ~/poky $ cd ~/poky
@ -532,46 +532,94 @@
in "<link linkend='modifying-the-kernel-source-code'>Modifying the Kernel Source in "<link linkend='modifying-the-kernel-source-code'>Modifying the Kernel Source
Code</link>" you should already have the Yocto Project files set up on your Code</link>" you should already have the Yocto Project files set up on your
host machine. host machine.
If this is the case, go to then next section titled
"<link linkend='examining-the-default-config-smp-behavior'>Examining the Default
<filename>CONFIG_SMP</filename> Behavior</link>" and continue with the
example.
</para> </para>
<para> <para>
If you don't have the Yocto Project files established on your system, If you don't have the Yocto Project files established on your system,
See "<link linkend='setting-up-the-local-yocto-project-files-git-repository'>Setting you can get them through tarball extraction or by
Up the Local Yocto Project Files Git Repository</link>" for cloning the <filename>poky</filename> Git repository.
information. This example uses <filename>poky</filename> as the root directory of the
To reconfigure the kernel, this is the only Git repository you need to have set up. local Yocto Project files Git repository.
See the bulleted item
"<link linkend='local-yp-release'>Yocto Project Release</link>"
for information on how to get these files.
</para> </para>
<!-- <para>
Once you have the repository set up,
you have many development branches from which you can work.
From inside the repository you can see the branch names and the tag names used
in the Git repository using either of the following two commands:
<literallayout class='monospaced'>
$ cd poky
$ git branch -a
$ git tag -l
</literallayout>
This example uses the Yocto Project 1.1.1 Release code named "edison",
which maps to the <filename>edison</filename> branch in the repository.
The following commands create and checkout the local <filename>edison</filename>
branch:
<literallayout class='monospaced'>
$ git checkout -b edison origin/edison
Branch edison set up to track remote branch edison from origin.
Switched to a new branch 'edison'
</literallayout>
</para>
<para> <para>
If you took the time to work through the example that modifies the kernel source code Next, you need to build the default <filename>qemux86</filename> image that you
in "<link linkend='modifying-the-kernel-source-code'>Modifying the Kernel Source can boot using QEMU.
Code</link>" you are already set up to quickly work through this example. <note>
If not, then work through the following list to prepare: Because a full build can take hours, you should check two variables in the
<itemizedlist> <filename>build</filename> directory that is created after you source the
<listitem><para><emphasis>Understand the development environment:</emphasis> <filename>oe-init-build-env</filename> script.
See "<link linkend='understanding-the-files-you-need'>Understanding You can find these variables
the Files You Need</link>" for information.</para></listitem> <filename>BB_NUMBER_THREADS</filename> and <filename>PARALLEL_MAKE</filename>
<listitem><para><emphasis>Set up the local Yocto Project files Git in the <filename>build/conf</filename> directory in the
repository:</emphasis> <filename>local.conf</filename> configuration file.
See "<link linkend='setting-up-the-local-yocto-project-files-git-repository'>Setting By default, these variables are commented out.
Up the Local Yocto Project Files Git Repository</link>" for If your host development system supports multi-core and multi-thread capabilities,
information.</para></listitem> you can uncomment these statements and set the variables to significantly shorten
<listitem><para><emphasis>Set up the <filename>poky-extras</filename> Git the full build time.
repository:</emphasis> As a guideline, set <filename>BB_NUMBER_THREADS</filename> to twice the number
See "<link linkend='setting-up-the-poky-extras-git-repository'>Setting of cores your machine supports and set <filename>PARALLEL_MAKE</filename> to one and
Up <filename>poky-extras</filename> Git repository</link>" for a half times the number of cores your machine supports.
information.</para></listitem> </note>
<listitem><para><emphasis>Set up the the bare clone and its copy:</emphasis> The following two commands <filename>source</filename> the build environment setup script
See "<link linkend='setting-up-the-bare-clone-and-its-copy'>Setting Up the and build the default <filename>qemux86</filename> image.
Bare Clone and its Copy</link>" for information.</para></listitem> If necessary, the script creates the build directory:
<listitem><para><emphasis>Build the default QEMU kernel image:</emphasis> <literallayout class='monospaced'>
See "<link linkend='building-and-booting-the-default-qemu-kernel-image'>Building $ cd ~/poky
and Booting the Default QEMU Kernel image</link>" for information. $ source oe-init-build-env
Do not boot the image in the QEMU emulator at this point.</para></listitem>
</itemizedlist> ### Shell environment set up for builds. ###
</para> -->
You can now run 'bitbake &lt;target&gt;'
Common targets are:
core-image-minimal
core-image-sato
meta-toolchain
meta-toolchain-sdk
adt-installer
meta-ide-support
You can also run generated qemu images with a command like 'runqemu qemux86'
</literallayout>
</para>
<para>
The following <filename>bitbake</filename> command starts the build:
<literallayout class='monospaced'>
$ bitbake -k core-image-minimal
</literallayout>
<note>Be sure to check the settings in the <filename>local.conf</filename>
before starting the build.</note>
</para>
</section> </section>
<section id='examining-the-default-config-smp-behavior'> <section id='examining-the-default-config-smp-behavior'>