summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-kernel-appendix.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-01-24 21:25:11 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-01-30 16:06:02 +0000
commitb5a4e78df5e98d1c0d03a36143d81f929b2f5aa2 (patch)
treec5cdec4ed9eeebb936162df4fe4d4e3fd85edf3b /documentation/dev-manual/dev-manual-kernel-appendix.xml
parent68b55c1e85168f5b46e39805927e3c67e481a3ba (diff)
downloadpoky-b5a4e78df5e98d1c0d03a36143d81f929b2f5aa2.tar.gz
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>
Diffstat (limited to 'documentation/dev-manual/dev-manual-kernel-appendix.xml')
-rw-r--r--documentation/dev-manual/dev-manual-kernel-appendix.xml116
1 files changed, 82 insertions, 34 deletions
diff --git a/documentation/dev-manual/dev-manual-kernel-appendix.xml b/documentation/dev-manual/dev-manual-kernel-appendix.xml
index efbe9d4c60..06db1f91a8 100644
--- a/documentation/dev-manual/dev-manual-kernel-appendix.xml
+++ b/documentation/dev-manual/dev-manual-kernel-appendix.xml
@@ -248,8 +248,8 @@
248 of cores your machine supports and set <filename>PARALLEL_MAKE</filename> to one and 248 of cores your machine supports and set <filename>PARALLEL_MAKE</filename> to one and
249 a half times the number of cores your machine supports. 249 a half times the number of cores your machine supports.
250 </note> 250 </note>
251 The following two commands build the default <filename>qemux86</filename> image and 251 The following two commands <filename>source</filename> the build environment setup script
252 <filename>source</filename> build environment setup script. 252 and build the default <filename>qemux86</filename> image.
253 If necessary, the script creates the build directory: 253 If necessary, the script creates the build directory:
254 <literallayout class='monospaced'> 254 <literallayout class='monospaced'>
255 $ cd ~/poky 255 $ cd ~/poky
@@ -532,46 +532,94 @@
532 in "<link linkend='modifying-the-kernel-source-code'>Modifying the Kernel Source 532 in "<link linkend='modifying-the-kernel-source-code'>Modifying the Kernel Source
533 Code</link>" you should already have the Yocto Project files set up on your 533 Code</link>" you should already have the Yocto Project files set up on your
534 host machine. 534 host machine.
535 If this is the case, go to then next section titled
536 "<link linkend='examining-the-default-config-smp-behavior'>Examining the Default
537 <filename>CONFIG_SMP</filename> Behavior</link>" and continue with the
538 example.
535 </para> 539 </para>
536 540
537 <para> 541 <para>
538 If you don't have the Yocto Project files established on your system, 542 If you don't have the Yocto Project files established on your system,
539 See "<link linkend='setting-up-the-local-yocto-project-files-git-repository'>Setting 543 you can get them through tarball extraction or by
540 Up the Local Yocto Project Files Git Repository</link>" for 544 cloning the <filename>poky</filename> Git repository.
541 information. 545 This example uses <filename>poky</filename> as the root directory of the
542 To reconfigure the kernel, this is the only Git repository you need to have set up. 546 local Yocto Project files Git repository.
547 See the bulleted item
548 "<link linkend='local-yp-release'>Yocto Project Release</link>"
549 for information on how to get these files.
543 </para> 550 </para>
544 551
545<!-- 552 <para>
553 Once you have the repository set up,
554 you have many development branches from which you can work.
555 From inside the repository you can see the branch names and the tag names used
556 in the Git repository using either of the following two commands:
557 <literallayout class='monospaced'>
558 $ cd poky
559 $ git branch -a
560 $ git tag -l
561 </literallayout>
562 This example uses the Yocto Project 1.1.1 Release code named "edison",
563 which maps to the <filename>edison</filename> branch in the repository.
564 The following commands create and checkout the local <filename>edison</filename>
565 branch:
566 <literallayout class='monospaced'>
567 $ git checkout -b edison origin/edison
568 Branch edison set up to track remote branch edison from origin.
569 Switched to a new branch 'edison'
570 </literallayout>
571 </para>
546 572
547 <para> 573 <para>
548 If you took the time to work through the example that modifies the kernel source code 574 Next, you need to build the default <filename>qemux86</filename> image that you
549 in "<link linkend='modifying-the-kernel-source-code'>Modifying the Kernel Source 575 can boot using QEMU.
550 Code</link>" you are already set up to quickly work through this example. 576 <note>
551 If not, then work through the following list to prepare: 577 Because a full build can take hours, you should check two variables in the
552 <itemizedlist> 578 <filename>build</filename> directory that is created after you source the
553 <listitem><para><emphasis>Understand the development environment:</emphasis> 579 <filename>oe-init-build-env</filename> script.
554 See "<link linkend='understanding-the-files-you-need'>Understanding 580 You can find these variables
555 the Files You Need</link>" for information.</para></listitem> 581 <filename>BB_NUMBER_THREADS</filename> and <filename>PARALLEL_MAKE</filename>
556 <listitem><para><emphasis>Set up the local Yocto Project files Git 582 in the <filename>build/conf</filename> directory in the
557 repository:</emphasis> 583 <filename>local.conf</filename> configuration file.
558 See "<link linkend='setting-up-the-local-yocto-project-files-git-repository'>Setting 584 By default, these variables are commented out.
559 Up the Local Yocto Project Files Git Repository</link>" for 585 If your host development system supports multi-core and multi-thread capabilities,
560 information.</para></listitem> 586 you can uncomment these statements and set the variables to significantly shorten
561 <listitem><para><emphasis>Set up the <filename>poky-extras</filename> Git 587 the full build time.
562 repository:</emphasis> 588 As a guideline, set <filename>BB_NUMBER_THREADS</filename> to twice the number
563 See "<link linkend='setting-up-the-poky-extras-git-repository'>Setting 589 of cores your machine supports and set <filename>PARALLEL_MAKE</filename> to one and
564 Up <filename>poky-extras</filename> Git repository</link>" for 590 a half times the number of cores your machine supports.
565 information.</para></listitem> 591 </note>
566 <listitem><para><emphasis>Set up the the bare clone and its copy:</emphasis> 592 The following two commands <filename>source</filename> the build environment setup script
567 See "<link linkend='setting-up-the-bare-clone-and-its-copy'>Setting Up the 593 and build the default <filename>qemux86</filename> image.
568 Bare Clone and its Copy</link>" for information.</para></listitem> 594 If necessary, the script creates the build directory:
569 <listitem><para><emphasis>Build the default QEMU kernel image:</emphasis> 595 <literallayout class='monospaced'>
570 See "<link linkend='building-and-booting-the-default-qemu-kernel-image'>Building 596 $ cd ~/poky
571 and Booting the Default QEMU Kernel image</link>" for information. 597 $ source oe-init-build-env
572 Do not boot the image in the QEMU emulator at this point.</para></listitem> 598
573 </itemizedlist> 599 ### Shell environment set up for builds. ###
574 </para> --> 600
601 You can now run 'bitbake &lt;target&gt;'
602
603 Common targets are:
604 core-image-minimal
605 core-image-sato
606 meta-toolchain
607 meta-toolchain-sdk
608 adt-installer
609 meta-ide-support
610
611 You can also run generated qemu images with a command like 'runqemu qemux86'
612 </literallayout>
613 </para>
614
615 <para>
616 The following <filename>bitbake</filename> command starts the build:
617 <literallayout class='monospaced'>
618 $ bitbake -k core-image-minimal
619 </literallayout>
620 <note>Be sure to check the settings in the <filename>local.conf</filename>
621 before starting the build.</note>
622 </para>
575 </section> 623 </section>
576 624
577 <section id='examining-the-default-config-smp-behavior'> 625 <section id='examining-the-default-config-smp-behavior'>