From 9bdc18a82017d549217a813a6da5d1267fb737e3 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 9 Mar 2012 17:38:00 -0600 Subject: documentation/poky-ref-manual: Converted to use poky.ent variables. Fixed all the hard links to use appropriate variables from the file poky.ent. (From yocto-docs rev: 9a6267d0d843dc47c1171eba6200387901b77df4) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/poky-ref-manual/development.xml | 31 +++++++++++----------- documentation/poky-ref-manual/faq.xml | 22 +++++++-------- documentation/poky-ref-manual/introduction.xml | 21 +++++++-------- documentation/poky-ref-manual/poky-ref-manual.xml | 9 ++++--- documentation/poky-ref-manual/ref-bitbake.xml | 10 ++++--- documentation/poky-ref-manual/ref-classes.xml | 12 +++++---- documentation/poky-ref-manual/ref-features.xml | 3 ++- documentation/poky-ref-manual/ref-images.xml | 3 ++- documentation/poky-ref-manual/ref-structure.xml | 14 +++++----- documentation/poky-ref-manual/ref-variables.xml | 29 +++++++++++--------- documentation/poky-ref-manual/ref-varlocality.xml | 3 ++- documentation/poky-ref-manual/resources.xml | 25 ++++++++--------- .../poky-ref-manual/technical-details.xml | 18 +++++++------ documentation/poky-ref-manual/usingpoky.xml | 10 ++++--- 14 files changed, 114 insertions(+), 96 deletions(-) (limited to 'documentation/poky-ref-manual') diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml index c2a9cf7f41..cf396dff3d 100644 --- a/documentation/poky-ref-manual/development.xml +++ b/documentation/poky-ref-manual/development.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > Platform Development with the Yocto Project @@ -82,7 +83,7 @@ The current release of the Yocto Project no longer supports the Anjuta plug-in. However, the Poky Anjuta Plug-in is available to download directly from the Poky Git repository located through the web interface at - under IDE Plugins. + under IDE Plugins. The community is free to continue supporting it beyond the Yocto Project 0.9 Release. @@ -91,8 +92,8 @@ with other plug-ins installed into the Eclipse IDE. Once you have your environment setup you need to configure the Eclipse plug-in. For information on how to install and configure the Eclipse plug-in, see the - "Working Within Eclipse" - chapter in The Yocto Project Application Development Toolkit (ADT) User's Guide. + "Working Within Eclipse" + chapter in the Yocto Project Application Development Toolkit (ADT) User's Guide. @@ -100,8 +101,8 @@ External Development Using the QEMU Emulator Running Poky QEMU images is covered in the - "A Quick Test Run" - section of The Yocto Project Quick Start. + "A Quick Test Run" + section of the Yocto Project Quick Start. The QEMU images shipped with the Yocto Project contain complete toolchains @@ -160,8 +161,8 @@ Working directly with the Yocto Project is a fast and effective development technique. The idea is that you can directly edit files in a working directory - (WORKDIR) - or the source directory (S) + (WORKDIR) + or the source directory (S) and then force specific tasks to rerun in order to test the changes. An example session working on the matchbox-desktop package might look like this: @@ -201,9 +202,9 @@ It is useful when making changes directly to the work directory files to do so using the Quilt tool as detailed in the - "Using a Quilt Workflow" section in the Yocto Project Development Manual. + "Using a Quilt Workflow" section in the Yocto Project Development Manual. Using Quilt, you can copy patches into the recipe directory and use the patches directly - through use of the SRC_URI variable. + through use of the SRC_URI variable. @@ -258,7 +259,7 @@ or compile commands as if they were being run by the Yocto Project build system itself. As noted earlier, the working directory also automatically changes to the - source directory (S). + source directory (S). @@ -268,8 +269,8 @@ The default shell used by devshell is xterm. You can use other terminal forms by setting the - TERMCMD and - TERMCMDRUN variables + TERMCMD and + TERMCMDRUN variables in the Yocto Project's local.conf file found in the build directory. For examples of the other options available, see the "UI/Interaction Configuration" @@ -667,7 +668,7 @@ A graphical user interface for OProfile is also available. You can download and build this interface from the Yocto Project at - . + . If the "tools-profile" image feature is selected, all necessary binaries are installed onto the target device for OProfileUI interaction. @@ -675,7 +676,7 @@ Even though the Yocto Project usually includes all needed patches on the target device, you might find you need other OProfile patches for recent OProfileUI features. - If so, see the + If so, see the OProfileUI README for the most recent information. diff --git a/documentation/poky-ref-manual/faq.xml b/documentation/poky-ref-manual/faq.xml index 4cf52443c1..0a64147523 100644 --- a/documentation/poky-ref-manual/faq.xml +++ b/documentation/poky-ref-manual/faq.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > FAQ @@ -7,13 +8,13 @@ - How does Poky differ from OpenEmbedded? + How does Poky differ from OpenEmbedded? Poky is the Yocto Project build system that was derived from OpenEmbedded. + url='&OE_HOME_URL;'>OpenEmbedded. Poky is a stable, smaller subset focused on the mobile environment. Development in the Yocto Project using Poky is closely tied to OpenEmbedded with features being merged regularly between the two for mutual benefit. @@ -33,8 +34,8 @@ You can use a stand-alone tarball to provide Python 2.6. You can find pre-built 32 and 64-bit versions of Python 2.6 at the following locations: - 32-bit tarball - 64-bit tarball + 32-bit tarball + 64-bit tarball @@ -139,7 +140,8 @@ To add a package, you need to create a BitBake recipe. For information on how to add a package, see the section - "Adding a Package" in the Yocto Project Development Manual. + "Adding a Package" + in the Yocto Project Development Manual. @@ -170,7 +172,7 @@ - GNOME Mobile is a subset of the GNOME + GNOME Mobile is a subset of the GNOME platform targeted at mobile and embedded devices. The the main difference between GNOME Mobile and standard GNOME is that desktop-orientated libraries have been removed, along with deprecated libraries, @@ -216,7 +218,7 @@ DAG repository help2man from - Karan repository + Karan repository @@ -269,9 +271,7 @@ = "0" in the .bb file but make sure the package is manually marked as machine-specific in the case that needs it. - The code that handles - - SRC_URI_OVERRIDES_PACKAGE_ARCH is in base.bbclass. + The code that handles SRC_URI_OVERRIDES_PACKAGE_ARCH is in base.bbclass. diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml index fd98c3248b..160cdca73d 100644 --- a/documentation/poky-ref-manual/introduction.xml +++ b/documentation/poky-ref-manual/introduction.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > Introduction @@ -15,13 +16,13 @@ construct complete Linux images. You can find complete introductory and getting started information on the Yocto Project by reading the - + Yocto Project Quick Start. For task-based information using the Yocto Project, see - + The Yocto Project Development Manual. You can also find lots of information on the Yocto Project on the - Yocto Project website. + Yocto Project website. @@ -94,10 +95,8 @@ System Requirements For Yocto Project system requirements, see the - - What You Need and How You Get It section in the - - Yocto Project Quick Start. + + What You Need and How You Get It section in the Yocto Project Quick Start. @@ -108,14 +107,14 @@ of methods: Releases: Stable, tested releases are available through - . + . Nightly Builds: These releases are available at . These builds include Yocto Project releases, meta-toolchain tarballs, and experimental builds. Yocto Project Website: You can find releases of the Yocto Project and supported BSPs at the - Yocto Project website. + Yocto Project website. Along with these downloads, you can find lots of other information at this site. @@ -129,7 +128,7 @@ You can get these files by downloading a Yocto Project release tarball and unpacking it, or by establishing a Git repository of the files. For information on both these methods, see the - "Getting Setup" + "Getting Setup" section in The Yocto Project Development Manual. diff --git a/documentation/poky-ref-manual/poky-ref-manual.xml b/documentation/poky-ref-manual/poky-ref-manual.xml index b07f213c13..2039fba063 100644 --- a/documentation/poky-ref-manual/poky-ref-manual.xml +++ b/documentation/poky-ref-manual/poky-ref-manual.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > - 2007-2012 + ©RIGHT_YEAR; Linux Foundation @@ -77,9 +78,9 @@ Due to production processes, there could be differences between the Yocto Project documentation bundled in the release tarball and - + The Yocto Project Reference Manual on - the Yocto Project website. + the Yocto Project website. For the latest version of this manual, see the manual on the website. diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml index 146f95d9e4..e8a5dc60ab 100644 --- a/documentation/poky-ref-manual/ref-bitbake.xml +++ b/documentation/poky-ref-manual/ref-bitbake.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > @@ -86,7 +87,8 @@ meta/recipes-*/ directory within Poky. Adding extra content to BBFILES is best achieved through the use of BitBake layers as described in the - "Understanding and Creating Layers" section of the Yocto Project Development Manual. + "Understanding and + Creating Layers" section of the Yocto Project Development Manual. @@ -207,8 +209,8 @@ It is worth noting that you can greatly speed up the build time by properly setting the BB_NUMBER_THREADS variable. See the - "Building an Image" - section in The Yocto Project Quick Start for more information. + "Building an Image" + section in the Yocto Project Quick Start for more information. diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml index e2bf9fed99..35c713434c 100644 --- a/documentation/poky-ref-manual/ref-classes.xml +++ b/documentation/poky-ref-manual/ref-classes.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > Reference: Classes @@ -52,7 +53,8 @@ and then simply inherit autotools. This class can also work with software that emulates Autotools. For more information, see the - "Autotooled Package" section in the Yocto Project Development Manual. + "Autotooled Package" + section in the Yocto Project Development Manual. @@ -314,9 +316,9 @@ You can find additional information on the effects of the package class at these two Yocto Project mailing list links: - + https://lists.yoctoproject.org/pipermail/poky/2011-May/006362.html - + https://lists.yoctoproject.org/pipermail/poky/2011-May/006363.html @@ -577,7 +579,7 @@ For information on how to use this class, see the - "Building + "Building Software from an External Source" section in the Yocto Project Development Manual. diff --git a/documentation/poky-ref-manual/ref-features.xml b/documentation/poky-ref-manual/ref-features.xml index 6b3e5c241e..c61b985f8a 100644 --- a/documentation/poky-ref-manual/ref-features.xml +++ b/documentation/poky-ref-manual/ref-features.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > Reference: Features diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml index 1e0b601a4a..a732e2ab92 100644 --- a/documentation/poky-ref-manual/ref-images.xml +++ b/documentation/poky-ref-manual/ref-images.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > Reference: Images diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index d12604536c..3af4139151 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > @@ -14,8 +15,8 @@ For information on how to establish the Yocto Project files on your local development system, see the - "Getting Setup" - section in The Yocto Project Development Manual. + "Getting Set Up" + section in the Yocto Project Development Manual.
@@ -387,7 +388,8 @@ Within this directory, the source is unpacked to linux-qemux86-standard-build and then patched by Quilt (see the - "Modifying Package Source Code with Quilt" section in the Yocto Project Development Manual. + "Modifying Package + Source Code with Quilt" section in the Yocto Project Development Manual. Within the linux-qemux86-standard-build directory, standard Quilt directories linux-3.0/patches and linux-3.0/.pc are created, @@ -478,8 +480,8 @@ <filename>meta/recipes-bsp/</filename> - This directory contains anything linking to specific hardware or hardware configuration information - such as "u-boot" and "grub". + This directory contains anything linking to specific hardware or hardware + configuration information such as "u-boot" and "grub".
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 8356cb4a5c..d2b96048b2 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > @@ -421,8 +422,9 @@ Alias names used for the recipe in various Linux distributions. See the - "Handling a Package Name Alias" - section in the Yocto Project Development Manual for more information. + "Handling + a Package Name Alias" section in the Yocto Project Development + Manual for more information. @@ -466,7 +468,8 @@ You can safely share this directory between multiple builds on the same development machine. - For additional information on how the build process gets source files, see the + For additional information on how the build process gets source files + when working behind a firewall or proxy server, see the "FAQ" appendix. @@ -663,7 +666,7 @@ The default value for the FILESPATH variable is defined in the base.bbclass class found in meta/classes in the - Yocto Project Files: + Yocto Project Files: FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ "${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \ @@ -1085,7 +1088,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ is set to "CLOSED") For more information, see the - Track License Change section + Tracking License Changes section @@ -1577,7 +1580,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ S - The location in the + The location in the Yocto Project Build Directory where unpacked package source code resides. This location is within the working directory (WORKDIR), which @@ -1590,7 +1593,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ ${WORKDIR}/${PN}-${PV} As an example, assume a - + Yocto Project Files top-level directory named poky and a default Yocto Project Build Directory of poky/build. In this case, the working directory the build system uses to build @@ -1859,7 +1862,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ uses when it does its work building images. By default, the TMPDIR variable is named tmp within the - + Yocto Project Build Directory. @@ -1867,7 +1870,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ If you want to establish this directory in a location other than the default, you can uncomment the following statement in the conf/local.conf file in the - + Yocto Project Files: #TMPDIR = "${TOPDIR}/tmp" @@ -1880,7 +1883,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ This variable is the - + Yocto Project Build Directory. BitBake automatically sets this variable. The Yocto Project build system uses the build directory when building images. @@ -1928,10 +1931,10 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} As an example, assume a - + Yocto Project Files top-level directory named poky and a default - + Yocto Project Build Directory of poky/build. In this case, the working directory the build system uses to build the v86d package is the following: diff --git a/documentation/poky-ref-manual/ref-varlocality.xml b/documentation/poky-ref-manual/ref-varlocality.xml index dcf4e7be1e..60cb998160 100644 --- a/documentation/poky-ref-manual/ref-varlocality.xml +++ b/documentation/poky-ref-manual/ref-varlocality.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > Reference: Variable Context diff --git a/documentation/poky-ref-manual/resources.xml b/documentation/poky-ref-manual/resources.xml index a3b5e0806f..5dc6153bcb 100644 --- a/documentation/poky-ref-manual/resources.xml +++ b/documentation/poky-ref-manual/resources.xml @@ -1,5 +1,6 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > Contributing to the Yocto Project @@ -10,8 +11,8 @@ The Yocto Project team is happy for people to experiment with the Yocto Project. A number of places exist to find help if you run into difficulties or find bugs. To find out how to download source code, - see the "Yocto Project Release" - list item in The Yocto Project Development Manual. + see the "Yocto Project Release" + list item in the Yocto Project Development Manual. @@ -20,7 +21,7 @@ If you find problems with the Yocto Project, you should report them using the - Bugzilla application at . + Bugzilla application at . @@ -31,13 +32,13 @@ To subscribe to the Yocto Project mailing lists, click on the following URLs and follow the instructions: - : + : Use this list to receive offical Yocto Project announcements for developments and to learn about Yocto Project milestones. - : + : Use this list to monitor Yocto Project development discussions, ask questions, and get help. - : + : Use this list to monitor discussions about the Yocto Project build system Poky, ask questions, and get help. @@ -62,15 +63,15 @@ Following is a list of resources you will find helpful: - The Yocto Project website: + The Yocto Project website: The home site for the Yocto Project. - OpenedHand: + OpenedHand: The company where the Yocto Project build system Poky was first developed. OpenedHand has since been acquired by Intel Corporation. Intel Corporation: The company who acquired OpenedHand in 2008 and continues development on the Yocto Project. - OpenEmbedded: + OpenEmbedded: The upstream, generic, embedded distribution the Yocto Project build system (Poky) derives from and to which it contributes. @@ -95,8 +96,8 @@ You can submit changes to the project either by creating and sending pull requests, or by submitting patches through email. For information on how to do both, see the - "How to Submit a Change" - section in The Yocto Project Development Manual. + "How to Submit a Change" + section in the Yocto Project Development Manual. diff --git a/documentation/poky-ref-manual/technical-details.xml b/documentation/poky-ref-manual/technical-details.xml index 840c9e3e7a..af62ee4f35 100644 --- a/documentation/poky-ref-manual/technical-details.xml +++ b/documentation/poky-ref-manual/technical-details.xml @@ -1,5 +1,7 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > + Technical Details @@ -31,16 +33,16 @@ Configuration data acts as the glue to bind everything together. For more information on data, see the - "Yocto Project Terms" - section in The Yocto Project Development Manual. + "Yocto Project Terms" + section in the Yocto Project Development Manual. BitBake knows how to combine multiple data sources together and refers to each data source as a layer. For information on layers, see the - "Understanding and Creating Layers" - section of the Yocto Project Development Manual. + "Understanding and + Creating Layers" section of the Yocto Project Development Manual. @@ -562,7 +564,7 @@ For an example of a commit that makes a cosmetic change to invalidate a shared state, see this - commit. + commit. @@ -623,10 +625,10 @@ In this example, the first line locates a file in - S/src/ls.c. + ${S}/src/ls.c. The second line refers to a file in WORKDIR, which is the parent - of S. + of S. Note that this variable is mandatory for all recipes, unless the diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml index 8dddb7a755..c80b080cc8 100644 --- a/documentation/poky-ref-manual/usingpoky.xml +++ b/documentation/poky-ref-manual/usingpoky.xml @@ -1,5 +1,7 @@ +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[ %poky; ] > + Using the Yocto Project @@ -15,7 +17,7 @@ You can find general information on how to build an image using the Yocto Project in the - "Building an Image" + "Building an Image" section of The Yocto Project Quick Start. This section provides a summary of the build process and provides information for less obvious aspects of the build process. @@ -91,8 +93,8 @@ tmp/deploy/images. For information on how to run pre-built images such as qemux86 and qemuarm, see the - "Using Pre-Built Binaries and QEMU" - section in The Yocto Project Quick Start. + "Using Pre-Built Binaries and QEMU" + section in the Yocto Project Quick Start. For information about how to install these images, see the documentation for your particular board/machine. -- cgit v1.2.3-54-g00ecf