From de01c5c2178e7e1f9c1608db57673ed075b5df74 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 13 Jun 2012 07:22:33 -0700 Subject: documentation/yocto-project-qs/yocto-project-qs.xml: 1.1.2 updates Initial pass to variablize this file and fold in various minor corrections discovered since 1.1.1 released. (From yocto-docs rev: 163c58f7f19d769adfacc963705c2063fe47c606) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../yocto-project-qs/yocto-project-qs.xml | 167 ++++++++++----------- 1 file changed, 82 insertions(+), 85 deletions(-) (limited to 'documentation') diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index ff96ceb8e5..ccc5cd6057 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -1,12 +1,13 @@ - + %poky; ] >
- Yocto Project Quick Start - Copyright © 2010-2012 Linux Foundation + The Yocto Project Quick Start + Copyright © ©RIGHT_YEAR; Linux Foundation
@@ -18,6 +19,7 @@ Amongst other things, the Yocto Project uses the Poky build system to construct complete Linux images. + This short document will give you some basic information about the environment as well as let you experience it in its simplest form. @@ -26,26 +28,28 @@ This document steps you through a simple example showing you how to build a small image and run it using the QEMU emulator. + - For complete information on the Yocto Project, you should check out the - Yocto Project Website. - Through the website, you can find the latest builds, breaking news, full development - documentation, and a - rich Yocto Project Development Community into which you can tap. - - - Finally, you might find the Frequently Asked Questions (FAQ) for the Yocto Project - at Yocto Project FAQ and - the FAQ appendix located in - - The Yocto Project Reference Manual helpful. + For more detailed information on the Yocto Project, you should check out these resources: + + Website: The Yocto Project Website + provides the latest builds, breaking news, full development documentation, and a rich Yocto + Project Development Community into which you can tap. + + FAQs: Lists commonly asked Yocto Project questions and answers. + You can find two FAQs: Yocto Project FAQ on + a wiki, and the + FAQ appendix in the + The Yocto Project Reference Manual. + + Due to production processes, there could be differences between the Yocto Project documentation bundled in the release tarball and the - + Yocto Project Quick Start on - the Yocto Project website. + the Yocto Project website. For the latest version of this manual, see the manual on the website.
@@ -156,11 +160,11 @@ openSUSE For a list of the distributions under validation and their status, see the - Distribution + Distribution Support wiki page. For notes about using the Yocto Project on a RHEL 4-based host, see the - BuildingOnRHEL4 + BuildingOnRHEL4 wiki page. @@ -174,12 +178,12 @@ If you attempt to use a distribution not in the above list, you may or may not have success - you are venturing into untested territory. Refer to - OE and Your Distro and - Required Software + OE and Your Distro and + Required Software for information for other distributions used with the OpenEmbedded project, which might be a starting point for exploration. If you go down this path, you should expect problems. - When you do, please go to Yocto Project Bugzilla + When you do, please go to Yocto Project Bugzilla and submit a bug. We are interested in hearing about your experience. @@ -213,8 +217,8 @@ $ sudo apt-get install sed wget cvs subversion git-core coreutils \ - unzip texi2html texinfo libsdl1.2-dev docbook-utils gawk \ - python-pysqlite2 diffstat help2man make gcc build-essential \ + unzip texi2html texinfo libsdl1.2-dev docbook-utils gawk fop \ + python-pysqlite2 diffstat help2man make gcc build-essential xsltproc \ g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev \ mercurial autoconf automake groff libtool xterm @@ -232,7 +236,7 @@ $ sudo yum groupinstall "development tools" $ sudo yum install python m4 make wget curl ftp hg tar bzip2 gzip \ unzip python-psyco perl texinfo texi2html diffstat openjade \ - docbook-style-dsssl sed docbook-style-xsl docbook-dtds \ + docbook-style-dsssl sed docbook-style-xsl docbook-dtds fop xsltproc \ docbook-utils sed bc eglibc-devel ccache pcre pcre-devel quilt \ groff linuxdoc-tools patch linuxdoc-tools cmake help2man \ perl-ExtUtils-MakeMaker tcl-devel gettext chrpath ncurses apr \ @@ -258,8 +262,8 @@ - $ sudo zypper install python gcc gcc-c++ libtool \ - subversion git chrpath automake make wget help2man \ + $ sudo zypper install python gcc gcc-c++ libtool fop \ + subversion git chrpath automake make wget help2man xsltproc \ diffstat texinfo mercurial freeglut-devel libSDL-devel @@ -270,13 +274,13 @@ You can download the latest Yocto Project release by going to the - Yocto Project Download page. + Yocto Project Download page. Just go to the page and click the "Yocto Downloads" link found in the "Download" navigation pane to the right to view all available Yocto Project releases. Then, click the "Yocto Release" link for the release you want from the list to begin the download. Nightly and developmental builds are also maintained at - . + . However, for this document a released version of Yocto Project is used. @@ -285,10 +289,8 @@ development system. Doing so allows you to contribute back to the project. For information on how to get set up using this method, see the - "Yocto - Project Release" item in - The Yocto Project - Development Manual. + "Yocto + Project Release" item in The Yocto Project Development Manual. @@ -297,7 +299,7 @@ A Quick Test Run - Now that you have your system requirements in order, you can give Yocto Project a try. + Now that you have your system requirements in order, you can give the Yocto Project a try. This section presents some steps that let you do the following: @@ -343,28 +345,28 @@ By default, the Yocto Project searches for source code using a pre-determined order through a set of locations. If you encounter problems with the Yocto Project finding and downloading source code, see - the FAQ entry "How does Poky obtain source code and will it work behind my + the FAQ entry "How does the Yocto Project build system obtain source code and will it work behind my firewall or proxy server?" in - + The Yocto Project Reference Manual. - $ wget http://downloads.yoctoproject.org/releases/yocto/yocto-1.1.1/poky-edison-6.0.1.tar.bz2 - $ tar xjf poky-edison-6.0.1.tar.bz2 - $ source poky-edison-6.0.1/oe-init-build-env edison-6.0.1-build + $ wget &YOCTO_POKY_DL_URL; + $ tar xjf &YOCTO_POKY;.tar.bz2 + $ source &OE_INIT_PATH; &YOCTO_POKY;-build To help conserve disk space during builds, you can add the following statement to your project's configuration file, which for this example - is edison-6.0.1-build/conf/local.conf. + is &YOCTO_POKY;-build/conf/local.conf. Adding this statement deletes the work directory used for building a package once the package is built. - INHERIT += rm_work + INHERIT += "rm_work" @@ -373,16 +375,16 @@ release tarball from the source repositories using the wget command. Alternatively, you can go to the - Yocto Project website - Downloads page to retrieve the tarball. + Yocto Project website's Downloads page + to retrieve the tarball. The second command extracts the files from the tarball and places - them into a directory named poky-edison-6.0.1 in the current + them into a directory named &YOCTO_POKY; in the current directory. The third command runs the Yocto Project environment setup script. Running this script defines Yocto Project build environment settings needed to complete the build. The script also creates the Yocto Project - build directory, which is edison-6.0.1-build in this case. + build directory, which is &YOCTO_POKY;-build in this case. After the script runs, your current working directory is set to the build directory. Later, when the build completes, the build directory contains all the files @@ -406,15 +408,12 @@ Another couple of variables of interest are the - BB_NUMBER_THREADS and the - PARALLEL_MAKE variables. + BB_NUMBER_THREADS and the + PARALLEL_MAKE variables. By default, these variables are commented out. However, if you have a multi-core CPU you might want to uncomment - the lines and set the variable - BB_NUMBER_THREADS equal to twice the number of your + the lines and set both variables equal to twice the number of your host's processor cores. - Also, you could set the variable PARALLEL_MAKE equal to - 1.5 times the number of processor cores. Setting these variables can significantly shorten your build time. @@ -423,11 +422,10 @@ the image. By default, the Yocto Project build system uses the RPM package manager. You can control this configuration by using the - PACKAGE_CLASSES variable. + PACKAGE_CLASSES variable. For additional package manager selection information, see - "Packaging - package*.bbclass" in - - The Yocto Project Reference Manual. + "Packaging - package*.bbclass" + in The Yocto Project Reference Manual. @@ -435,16 +433,16 @@ core-image-sato in this example. For information on the -k option use the bitbake --help command or see the - "BitBake" section in - The Yocto Project Reference Manual. + "BitBake" section in + The Yocto Project Reference Manual. $ bitbake -k core-image-sato BitBake requires Python 2.6 or 2.7. For more information on this requirement, - see the FAQ appendix in - - The Yocto Project Reference Manual. + see the + FAQ in The Yocto Project Reference + Manual. The final command runs the image: @@ -482,7 +480,7 @@ - Install the stand-alone Yocto toolchain tarball. + Install the appropriate stand-alone Yocto toolchain tarball. Download the pre-built image that will boot with QEMU. You need to be sure to get the QEMU image that matches your target machine’s architecture (e.g. x86, ARM, etc.). @@ -497,9 +495,9 @@ You can download the pre-built toolchain, which includes the runqemu script and support files, from the appropriate directory under - . + . Toolchains are available for 32-bit and 64-bit development systems from the - i686 and x86_64 directories, respectively. + i686 and x86-64 directories, respectively. Each type of development system supports five target architectures. The tarball files are named such that a string representing the host system appears first in the filename and then is immediately followed by a string representing @@ -507,7 +505,7 @@ - poky-eglibc<host_system>-<arch>-toolchain-gmae-<release>.tar.bz2 + poky-eglibc-<host_system>-<arch>-toolchain-gmae-<release>.tar.bz2 Where: <host_system> is a string representing your development system: @@ -525,7 +523,7 @@ - poky-eglibc-x86_64-i586-toolchain-gmae-1.1.1.tar.bz2 + poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 @@ -538,16 +536,15 @@ $ cd / - $ sudo tar -xvjf ~/toolchains/poky-eglibc-x86_64-i586-toolchain-gmae-1.1.1.tar.bz2 + $ sudo tar -xvjf ~/toolchains/poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 For more information on how to install tarballs, see the - "Using a Cross-Toolchain Tarball" and - "Using BitBake and the Yocto Project Build Tree" sections in - The Yocto Project - Application Development Toolkit (ADT) User's Guide. + "Using a Cross-Toolchain Tarball" and + "Using BitBake and the Yocto Project Build Tree" sections in The Yocto Project Application Development Toolkit (ADT) + User's Guide. @@ -556,11 +553,11 @@ You can download the pre-built Linux kernel suitable for running in the QEMU emulator from - . + . Be sure to use the kernel that matches the architecture you want to simulate. Download areas exist for the five supported machine architectures: qemuarm, qemumips, qemuppc, - qemux86, and qemux86_64. + qemux86, and qemux86-64. @@ -577,9 +574,8 @@ You can learn more about downloading a Yocto Project kernel in the - "Linux Yocto Kernel" section of - The - Yocto Project Development Manual. + "Linux Yocto Kernel" section of + The Yocto Project Development Manual. @@ -588,7 +584,7 @@ You can also download the filesystem image suitable for your target architecture from - . + . Again, be sure to use the filesystem that matches the architecture you want to simulate. @@ -599,7 +595,7 @@ You must use the ext3 form when booting an image using the QEMU emulator. The tar form can be flattened out in your host development system - and used for Yocto Project build purposes. + and used for build purposes with the Yocto Project. core-image-<profile>-qemu<arch>.ext3 core-image-<profile>-qemu<arch>.tar.bz2 @@ -608,7 +604,7 @@ <profile> is the filesystem image's profile: lsb, lsb-dev, lsb-sdk, lsb-qt3, minimal, minimal-dev, sato, sato-dev, or sato-sdk. For information on these types of image profiles, see - Reference: Images in the Yocto Project Reference Manual. + Reference: Images in the Yocto Project Reference Manual. <arch> is a string representing the target architecture: x86, x86-64, ppc, mips, or arm. @@ -623,7 +619,7 @@ Before you start the QEMU emulator, you need to set up the emulation environment. The following command form sets up the emulation environment. - $ source /opt/poky/1.1.1/environment-setup-<arch>-poky-linux-<if> + $ source &YOCTO_ADTPATH_DIR;/environment-setup-<arch>-poky-linux-<if> Where: <arch> is a string representing the target architecture: @@ -653,12 +649,13 @@ Continuing with the example, the following two commands setup the emulation environment and launch QEMU. - This example assumes the toolchain tarball has been downloaded and expanded - into /opt/poky and - that the kernel and filesystem are for a 32-bit target architecture. + This example assumes the root filesystem (.ext3 file) and + the pre-built kernel image file both reside in your home directory. + The kernel and filesystem are for a 32-bit target architecture. - $ source /opt/poky/1.1.1/environment-setup-i586-poky-linux - $ runqemu qemux86 bzImage-3.0-qemux86-1.1.1.bin \ + $ cd $HOME + $ source &YOCTO_ADTPATH_DIR;/environment-setup-i586-poky-linux + $ runqemu qemux86 bzImage-qemux86.bin \ core-image-sato-qemux86.ext3 -- cgit v1.2.3-54-g00ecf