From 39b508fb85c1079e40bd8b81fe9d85ab2cdda186 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 6 Jan 2012 15:13:34 -0600 Subject: [PATCH] documentation: Variables for docs and QS variablized Beth has created a scheme that uses a file named "poky.ent" that contains a load of variables that can be used throughout the documents for releases. The variables can be set in the poky.ent file and then sucked in during the make process to specify a release. This commit adds the new file and the changes to the YP QS manual. (From yocto-docs rev: b08dde630a4f0762d8cc62c5579f6917d93ee854) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/poky.ent | 46 ++++++++++ .../yocto-project-qs/yocto-project-qs.xml | 89 ++++++++++--------- 2 files changed, 91 insertions(+), 44 deletions(-) create mode 100644 documentation/poky.ent diff --git a/documentation/poky.ent b/documentation/poky.ent new file mode 100644 index 0000000000..c2d0c02a6b --- /dev/null +++ b/documentation/poky.ent @@ -0,0 +1,46 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 0f2ecf4110..4f02b0a996 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-2011 Linux Foundation + Copyright © ©RIGHT_YEAR; Linux Foundation
@@ -28,24 +29,24 @@ For complete information on the Yocto Project, you should check out the - Yocto Project Website. + 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 + at Yocto Project FAQ and the FAQ appendix located in - + The Yocto Project Reference Manual helpful. 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 +157,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 +175,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. @@ -261,13 +262,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. @@ -276,9 +277,9 @@ 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 + "Yocto Project Release" item in - The Yocto Project + The Yocto Project Development Manual. @@ -336,15 +337,15 @@ 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 firewall or proxy server?" in - + The Yocto Project Reference Manual. - $ wget http://downloads.yoctoproject.org/releases/yocto/yocto-1.1/poky-edison-6.0.tar.bz2 - $ tar xjf poky-edison-6.0.tar.bz2 - $ source poky-edison-6.0/oe-init-build-env edison-6.0-build + $ wget &YOCTO_POKY_DL_URL; + $ tar xjf &YOCTO_POKY;.tar.bz2 + $ source &OE_INIT_PATH; edison-6.0-build @@ -364,7 +365,7 @@ release tarball from the source repositories using the wget command. Alternatively, you can go to the - Yocto Project website + Yocto Project website 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 in the current @@ -397,8 +398,8 @@ 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 both variables equal to twice the number of your @@ -411,10 +412,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 - + "Packaging - package*.bbclass" in + The Yocto Project Reference Manual. @@ -423,15 +424,15 @@ 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. The final command runs the image: @@ -485,7 +486,7 @@ 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. Each type of development system supports five target architectures. @@ -513,7 +514,7 @@ - poky-eglibc-x86_64-i586-toolchain-gmae-1.1.tar.bz2 + poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 @@ -526,15 +527,15 @@ $ cd / - $ sudo tar -xvjf ~/toolchains/poky-eglibc-x86_64-i586-toolchain-gmae-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 + "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. @@ -544,7 +545,7 @@ 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, @@ -565,8 +566,8 @@ You can learn more about downloading a Yocto Project kernel in the - "Linux Yocto Kernel" section of - The + "Linux Yocto Kernel" section of + The Yocto Project Development Manual. @@ -576,7 +577,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. @@ -596,7 +597,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. @@ -611,7 +612,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/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: @@ -644,8 +645,8 @@ This example assumes the root filesystem tarball has been downloaded and expanded, and that the kernel and filesystem are for a 32-bit target architecture. - $ source /opt/poky/1.1/environment-setup-i686-poky-linux - $ runqemu qemux86 bzImage-3.0-qemux86-1.1.bin \ + $ source &YOCTO_ADTPATH_DIR;/environment-setup-i686-poky-linux + $ runqemu qemux86 bzImage-3.0-qemux86-&DISTRO;.bin \ core-image-sato-qemux86.ext3