diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-03-09 17:38:00 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-03-23 14:24:44 +0000 |
commit | 9bdc18a82017d549217a813a6da5d1267fb737e3 (patch) | |
tree | 5dfc02f96e623ecf40df721f946199fb0729a0dc | |
parent | 9602c5556baf60040fde5710564129633f7e9c4c (diff) | |
download | ast2050-yocto-poky-9bdc18a82017d549217a813a6da5d1267fb737e3.zip ast2050-yocto-poky-9bdc18a82017d549217a813a6da5d1267fb737e3.tar.gz |
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 <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/poky-ref-manual/development.xml | 31 | ||||
-rw-r--r-- | documentation/poky-ref-manual/faq.xml | 22 | ||||
-rw-r--r-- | documentation/poky-ref-manual/introduction.xml | 21 | ||||
-rw-r--r-- | documentation/poky-ref-manual/poky-ref-manual.xml | 9 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-bitbake.xml | 10 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-classes.xml | 12 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-features.xml | 3 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-images.xml | 3 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-structure.xml | 14 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 29 | ||||
-rw-r--r-- | documentation/poky-ref-manual/ref-varlocality.xml | 3 | ||||
-rw-r--r-- | documentation/poky-ref-manual/resources.xml | 25 | ||||
-rw-r--r-- | documentation/poky-ref-manual/technical-details.xml | 18 | ||||
-rw-r--r-- | documentation/poky-ref-manual/usingpoky.xml | 10 |
14 files changed, 114 insertions, 96 deletions
diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml index c2a9cf7..cf396df 100644 --- a/documentation/poky-ref-manual/development.xml +++ b/documentation/poky-ref-manual/development.xml @@ -1,5 +1,6 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <chapter id="platdev"> <title>Platform Development with the Yocto Project</title> @@ -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 - <ulink url="http://git.yoctoproject.org/"></ulink> under IDE Plugins. + <ulink url='&YOCTO_GIT_URL;'></ulink> under IDE Plugins. The community is free to continue supporting it beyond the Yocto Project 0.9 Release. </note> @@ -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 - "<ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html#adt-eclipse'>Working Within Eclipse</ulink>" - chapter in The Yocto Project Application Development Toolkit (ADT) User's Guide. + "<ulink url='&YOCTO_DOCS_ADT_URL;#adt-eclipse'>Working Within Eclipse</ulink>" + chapter in the Yocto Project Application Development Toolkit (ADT) User's Guide. </para> </section> @@ -100,8 +101,8 @@ <title>External Development Using the QEMU Emulator</title> <para> Running Poky QEMU images is covered in the - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#test-run'>A Quick Test Run</ulink>" - section of The Yocto Project Quick Start. + "<ulink url='&YOCTO_DOCS_QS_URL;#test-run'>A Quick Test Run</ulink>" + section of the Yocto Project Quick Start. </para> <para> The QEMU images shipped with the Yocto Project contain complete toolchains @@ -160,8 +161,8 @@ <para> 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 - (<glossterm><link linkend='var-WORKDIR'>WORKDIR</link></glossterm>) - or the source directory (<glossterm><link linkend='var-S'>S</link></glossterm>) + (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>) + or the source directory (<filename><link linkend='var-S'>S</link></filename>) 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 @@ <para> It is useful when making changes directly to the work directory files to do so using the Quilt tool as detailed in the - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#using-a-quilt-workflow'>Using a Quilt Workflow</ulink>" section in the Yocto Project Development Manual. + "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Using a Quilt Workflow</ulink>" 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 <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm> variable. + through use of the <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> variable. </para> <para> @@ -258,7 +259,7 @@ or <filename>compile</filename> 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 (<glossterm><link linkend='var-S'>S</link></glossterm>). + source directory (<filename><link linkend='var-S'>S</link></filename>). </para> <para> @@ -268,8 +269,8 @@ <para> The default shell used by <filename>devshell</filename> is xterm. You can use other terminal forms by setting the - <glossterm><link linkend='var-TERMCMD'>TERMCMD</link></glossterm> and - <glossterm><link linkend='var-TERMCMDRUN'>TERMCMDRUN</link></glossterm> variables + <filename><link linkend='var-TERMCMD'>TERMCMD</link></filename> and + <filename><link linkend='var-TERMCMDRUN'>TERMCMDRUN</link></filename> variables in the Yocto Project's <filename>local.conf</filename> file found in the build directory. For examples of the other options available, see the "UI/Interaction Configuration" @@ -667,7 +668,7 @@ <para> A graphical user interface for OProfile is also available. You can download and build this interface from the Yocto Project at - <ulink url="http://git.yoctoproject.org/cgit.cgi/oprofileui/"></ulink>. + <ulink url="&YOCTO_GIT_URL;/cgit.cgi/oprofileui/"></ulink>. If the "tools-profile" image feature is selected, all necessary binaries are installed onto the target device for OProfileUI interaction. </para> @@ -675,7 +676,7 @@ <para> 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 <ulink url='http://git.yoctoproject.org/cgit.cgi/oprofileui/tree/README'> + If so, see the <ulink url='&YOCTO_GIT_URL;/cgit.cgi/oprofileui/tree/README'> OProfileUI README</ulink> for the most recent information. </para> diff --git a/documentation/poky-ref-manual/faq.xml b/documentation/poky-ref-manual/faq.xml index 4cf5244..0a64147 100644 --- a/documentation/poky-ref-manual/faq.xml +++ b/documentation/poky-ref-manual/faq.xml @@ -1,5 +1,6 @@ <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <appendix id='faq'> <title>FAQ</title> @@ -7,13 +8,13 @@ <qandaentry> <question> <para> - How does Poky differ from <ulink url='http://www.openembedded.org/'>OpenEmbedded</ulink>? + How does Poky differ from <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>? </para> </question> <answer> <para> Poky is the Yocto Project build system that was derived from <ulink - url='http://www.openembedded.org/'>OpenEmbedded</ulink>. + url='&OE_HOME_URL;'>OpenEmbedded</ulink>. 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: <itemizedlist> - <listitem><para><ulink url='http://downloads.yoctoproject.org/releases/miscsupport/yocto-1.0-python-nativesdk/python-nativesdk-standalone-i686.tar.bz2'>32-bit tarball</ulink></para></listitem> - <listitem><para><ulink url='http://downloads.yoctoproject.org/releases/miscsupport/yocto-1.0-python-nativesdk/python-nativesdk-standalone-x86_64.tar.bz2'>64-bit tarball</ulink></para></listitem> + <listitem><para><ulink url='&YOCTO_PYTHON-i686_DL_URL;'>32-bit tarball</ulink></para></listitem> + <listitem><para><ulink url='&YOCTO_PYTHON-x86_64_DL_URL;'>64-bit tarball</ulink></para></listitem> </itemizedlist> </para> <para> @@ -139,7 +140,8 @@ <para> To add a package, you need to create a BitBake recipe. For information on how to add a package, see the section - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#usingpoky-extend-addpkg'>Adding a Package</ulink>" in the Yocto Project Development Manual. + "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-addpkg'>Adding a Package</ulink>" + in the Yocto Project Development Manual. </para> </answer> </qandaentry> @@ -170,7 +172,7 @@ </question> <answer> <para> - <ulink url='http://www.gnome.org/mobile/'>GNOME Mobile</ulink> is a subset of the GNOME + GNOME Mobile is a subset of the <ulink url='http://www.gnome.org'>GNOME</ulink> 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 @@ <ulink url='http://dag.wieers.com/rpm/packages/python-sqlite2/'>DAG repository</ulink> </para></listitem> <listitem><para><filename>help2man</filename> from - <ulink url='http://centos.karan.org/el5/extras/testing/i386/RPMS/help2man-1.33.1-2.noarch.rpm'>Karan repository</ulink></para></listitem> + <ulink url='http://centos.karan.org/el4/extras/stable/x86_64/RPMS/repodata/repoview/help2man-0-1.33.1-2.html'>Karan repository</ulink></para></listitem> </itemizedlist> </para> @@ -269,9 +271,7 @@ </filename> = "0" in the <filename>.bb</filename> file but make sure the package is manually marked as machine-specific in the case that needs it. - The code that handles - <filename><link linkend='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'> - SRC_URI_OVERRIDES_PACKAGE_ARCH</link></filename> is in <filename>base.bbclass</filename>. + The code that handles <filename>SRC_URI_OVERRIDES_PACKAGE_ARCH</filename> is in <filename>base.bbclass</filename>. </para> </answer> </qandaentry> diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml index fd98c32..160cdca 100644 --- a/documentation/poky-ref-manual/introduction.xml +++ b/documentation/poky-ref-manual/introduction.xml @@ -1,5 +1,6 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <chapter id='intro'> <title>Introduction</title> @@ -15,13 +16,13 @@ construct complete Linux images. You can find complete introductory and getting started information on the Yocto Project by reading the - <ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'> + <ulink url='&YOCTO_DOCS_QS_URL;'> Yocto Project Quick Start</ulink>. For task-based information using the Yocto Project, see - <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'> + <ulink url='&YOCTO_DOCS_DEV_URL;'> The Yocto Project Development Manual</ulink>. You can also find lots of information on the Yocto Project on the - <ulink url="http://www.yoctoproject.org">Yocto Project website</ulink>. + <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>. </para> </section> @@ -94,10 +95,8 @@ <title>System Requirements</title> <para> For Yocto Project system requirements, see the - <ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#resources'> - What You Need and How You Get It</ulink> section in the - <ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'> - Yocto Project Quick Start</ulink>. + <ulink url='&YOCTO_DOCS_QS_URL;#resources'> + What You Need and How You Get It</ulink> section in the Yocto Project Quick Start. </para> </section> @@ -108,14 +107,14 @@ of methods: <itemizedlist> <listitem><para><emphasis>Releases:</emphasis> Stable, tested releases are available through - <ulink url='http://downloads.yoctoproject.org/releases/yocto/'/>.</para></listitem> + <ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem> <listitem><para><emphasis>Nightly Builds:</emphasis> These releases are available at <ulink url='http://autobuilder.yoctoproject.org/nightly'/>. These builds include Yocto Project releases, meta-toolchain tarballs, and experimental builds.</para></listitem> <listitem><para><emphasis>Yocto Project Website:</emphasis> You can find releases of the Yocto Project and supported BSPs at the - <ulink url='http://www.yoctoproject.org'>Yocto Project website</ulink>. + <ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>. Along with these downloads, you can find lots of other information at this site. </para></listitem> </itemizedlist> @@ -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 - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#getting-setup'>Getting Setup</ulink>" + "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Setup</ulink>" section in The Yocto Project Development Manual. </para> </section> diff --git a/documentation/poky-ref-manual/poky-ref-manual.xml b/documentation/poky-ref-manual/poky-ref-manual.xml index b07f213..2039fba 100644 --- a/documentation/poky-ref-manual/poky-ref-manual.xml +++ b/documentation/poky-ref-manual/poky-ref-manual.xml @@ -1,5 +1,6 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <book id='poky-ref-manual' lang='en' xmlns:xi="http://www.w3.org/2003/XInclude" @@ -65,7 +66,7 @@ </revhistory> <copyright> - <year>2007-2012</year> + <year>©RIGHT_YEAR;</year> <holder>Linux Foundation</holder> </copyright> @@ -77,9 +78,9 @@ <note> Due to production processes, there could be differences between the Yocto Project documentation bundled in the release tarball and - <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html'> + <ulink url='&YOCTO_DOCS_REF_URL;'> The Yocto Project Reference Manual</ulink> on - the <ulink url='http://www.yoctoproject.org'>Yocto Project</ulink> website. + the <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website. For the latest version of this manual, see the manual on the website. </note> </legalnotice> diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml index 146f95d..e8a5dc6 100644 --- a/documentation/poky-ref-manual/ref-bitbake.xml +++ b/documentation/poky-ref-manual/ref-bitbake.xml @@ -1,5 +1,6 @@ <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <appendix id='ref-bitbake'> @@ -86,7 +87,8 @@ <filename>meta/recipes-*/</filename> directory within Poky. Adding extra content to <filename>BBFILES</filename> is best achieved through the use of BitBake layers as described in the - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" section of the Yocto Project Development Manual. + "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and + Creating Layers</ulink>" section of the Yocto Project Development Manual. </para> <para> @@ -207,8 +209,8 @@ It is worth noting that you can greatly speed up the build time by properly setting the <filename>BB_NUMBER_THREADS</filename> variable. See the - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" - section in The Yocto Project Quick Start for more information. + "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" + section in the Yocto Project Quick Start for more information. </para> <para> diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml index e2bf9fe..35c7134 100644 --- a/documentation/poky-ref-manual/ref-classes.xml +++ b/documentation/poky-ref-manual/ref-classes.xml @@ -1,5 +1,6 @@ <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <appendix id='ref-classes'> <title>Reference: Classes</title> @@ -52,7 +53,8 @@ and then simply <filename>inherit autotools</filename>. This class can also work with software that emulates Autotools. For more information, see the - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#usingpoky-extend-addpkg-autotools'>Autotooled Package</ulink>" section in the Yocto Project Development Manual. + "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-addpkg-autotools'>Autotooled Package</ulink>" + section in the Yocto Project Development Manual. </para> <para> @@ -314,9 +316,9 @@ You can find additional information on the effects of the package class at these two Yocto Project mailing list links: <itemizedlist> - <listitem><para><ulink url='https://lists.yoctoproject.org/pipermail/poky/2011-May/006362.html'> + <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006362.html'> https://lists.yoctoproject.org/pipermail/poky/2011-May/006362.html</ulink></para></listitem> - <listitem><para><ulink url='https://lists.yoctoproject.org/pipermail/poky/2011-May/006363.html'> + <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006363.html'> https://lists.yoctoproject.org/pipermail/poky/2011-May/006363.html</ulink></para></listitem> </itemizedlist> </para> @@ -577,7 +579,7 @@ <para> For information on how to use this class, see the - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#building-software-from-an-external-source'>Building + "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>" section in the Yocto Project Development Manual. </para> </section> diff --git a/documentation/poky-ref-manual/ref-features.xml b/documentation/poky-ref-manual/ref-features.xml index 6b3e5c2..c61b985 100644 --- a/documentation/poky-ref-manual/ref-features.xml +++ b/documentation/poky-ref-manual/ref-features.xml @@ -1,5 +1,6 @@ <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <appendix id='ref-features'> <title>Reference: Features</title> diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml index 1e0b601..a732e2a 100644 --- a/documentation/poky-ref-manual/ref-images.xml +++ b/documentation/poky-ref-manual/ref-images.xml @@ -1,5 +1,6 @@ <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <appendix id='ref-images'> <title>Reference: Images</title> diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index d126045..3af4139 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml @@ -1,5 +1,6 @@ <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <appendix id='ref-structure'> @@ -14,8 +15,8 @@ <para> For information on how to establish the Yocto Project files on your local development system, see the - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#getting-started'>Getting Setup</ulink>" - section in The Yocto Project Development Manual. + "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>" + section in the Yocto Project Development Manual. </para> <section id='structure-core'> @@ -387,7 +388,8 @@ Within this directory, the source is unpacked to <filename>linux-qemux86-standard-build</filename> and then patched by Quilt (see the - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#usingpoky-modifying-packages-quilt'>Modifying Package Source Code with Quilt</ulink>" section in the Yocto Project Development Manual. + "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Modifying Package + Source Code with Quilt</ulink>" section in the Yocto Project Development Manual. Within the <filename>linux-qemux86-standard-build</filename> directory, standard Quilt directories <filename>linux-3.0/patches</filename> and <filename>linux-3.0/.pc</filename> are created, @@ -478,8 +480,8 @@ <title><filename>meta/recipes-bsp/</filename></title> <para> - 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". </para> </section> diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 8356cb4..d2b9604 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml @@ -1,5 +1,6 @@ <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <!-- Dummy chapter --> <appendix id='ref-variables-glos'> @@ -421,8 +422,9 @@ <glossdef> <para>Alias names used for the recipe in various Linux distributions.</para> <para>See the - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#usingpoky-configuring-DISTRO_PN_ALIAS'>Handling a Package Name Alias</ulink>" - section in the Yocto Project Development Manual for more information.</para> + "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-configuring-DISTRO_PN_ALIAS'>Handling + a Package Name Alias</ulink>" section in the Yocto Project Development + Manual for more information.</para> </glossdef> </glossentry> @@ -466,7 +468,8 @@ <para> 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 "<link linkend='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>FAQ</link>" appendix. </para> @@ -663,7 +666,7 @@ The default value for the <filename>FILESPATH</filename> variable is defined in the <filename>base.bbclass</filename> class found in <filename>meta/classes</filename> in the - <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'>Yocto Project Files</ulink>: + <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto Project Files</ulink>: <literallayout class='monospaced'> 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")</para> <para>For more information, see the <link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'> - Track License Change</link> section</para> + Tracking License Changes</link> section</para> </glossdef> </glossentry> @@ -1577,7 +1580,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ <glossentry id='var-S'><glossterm>S</glossterm> <glossdef> <para> - The location in the <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-build-directory'> + The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'> Yocto Project Build Directory</ulink> where unpacked package source code resides. This location is within the working directory (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which @@ -1590,7 +1593,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ ${WORKDIR}/${PN}-${PV} </literallayout> As an example, assume a - <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'> + <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'> Yocto Project Files</ulink> top-level directory named <filename>poky</filename> and a default Yocto Project Build Directory of <filename>poky/build</filename>. 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 <filename>TMPDIR</filename> variable is named <filename>tmp</filename> within the - <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-build-directory'> + <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'> Yocto Project Build Directory</ulink>. </para> @@ -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 <filename>conf/local.conf</filename> file in the - <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'> + <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'> Yocto Project Files</ulink>: <literallayout class='monospaced'> #TMPDIR = "${TOPDIR}/tmp" @@ -1880,7 +1883,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ <glossdef> <para> This variable is the - <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-build-directory'> + <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'> Yocto Project Build Directory</ulink>. 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} </literallayout> As an example, assume a - <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'> + <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'> Yocto Project Files</ulink> top-level directory named <filename>poky</filename> and a default - <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-build-directory'> + <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'> Yocto Project Build Directory</ulink> of <filename>poky/build</filename>. In this case, the working directory the build system uses to build the <filename>v86d</filename> package is the following: diff --git a/documentation/poky-ref-manual/ref-varlocality.xml b/documentation/poky-ref-manual/ref-varlocality.xml index dcf4e7b..60cb998 100644 --- a/documentation/poky-ref-manual/ref-varlocality.xml +++ b/documentation/poky-ref-manual/ref-varlocality.xml @@ -1,5 +1,6 @@ <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <appendix id='ref-varlocality'> <title>Reference: Variable Context</title> diff --git a/documentation/poky-ref-manual/resources.xml b/documentation/poky-ref-manual/resources.xml index a3b5e08..5dc6153 100644 --- a/documentation/poky-ref-manual/resources.xml +++ b/documentation/poky-ref-manual/resources.xml @@ -1,5 +1,6 @@ <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > <appendix id='resources'> <title>Contributing to the Yocto Project</title> @@ -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 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#local-yp-release'>Yocto Project Release</ulink>" - list item in The Yocto Project Development Manual. + see the "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto Project Release</ulink>" + list item in the Yocto Project Development Manual. </para> </section> @@ -20,7 +21,7 @@ <para> If you find problems with the Yocto Project, you should report them using the - Bugzilla application at <ulink url='http://bugzilla.yoctoproject.org/'></ulink>. + Bugzilla application at <ulink url='&YOCTO_BUGZILLA_URL;'></ulink>. </para> </section> @@ -31,13 +32,13 @@ To subscribe to the Yocto Project mailing lists, click on the following URLs and follow the instructions: <itemizedlist> <listitem><para><emphasis> - <ulink url='http://lists.yoctoproject.org/listinfo/yocto-announce'></ulink></emphasis>: + <ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink></emphasis>: Use this list to receive offical Yocto Project announcements for developments and to learn about Yocto Project milestones.</para></listitem> - <listitem><para><emphasis><ulink url='http://lists.yoctoproject.org/listinfo/yocto'></ulink></emphasis>: + <listitem><para><emphasis><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink></emphasis>: Use this list to monitor Yocto Project development discussions, ask questions, and get help.</para></listitem> - <listitem><para><emphasis><ulink url='http://lists.yoctoproject.org/listinfo/poky'></ulink></emphasis>: + <listitem><para><emphasis><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink></emphasis>: Use this list to monitor discussions about the Yocto Project build system Poky, ask questions, and get help.</para></listitem> </itemizedlist> @@ -62,15 +63,15 @@ <para> Following is a list of resources you will find helpful: <itemizedlist> - <listitem><para><emphasis><ulink url='http://yoctoproject.org'>The Yocto Project website</ulink>: + <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>The Yocto Project website</ulink>: </emphasis> The home site for the Yocto Project.</para></listitem> - <listitem><para><emphasis><ulink url='http://www.openedhand.com/'>OpenedHand</ulink>:</emphasis> + <listitem><para><emphasis><ulink url='&OH_HOME_URL;'>OpenedHand</ulink>:</emphasis> The company where the Yocto Project build system Poky was first developed. OpenedHand has since been acquired by Intel Corporation.</para></listitem> <listitem><para><emphasis><ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis> The company who acquired OpenedHand in 2008 and continues development on the Yocto Project.</para></listitem> - <listitem><para><emphasis><ulink url='http://www.openembedded.org/'>OpenEmbedded</ulink>:</emphasis> + <listitem><para><emphasis><ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis> The upstream, generic, embedded distribution the Yocto Project build system (Poky) derives from and to which it contributes.</para></listitem> <listitem><para><emphasis><ulink url='http://developer.berlios.de/projects/bitbake/'> @@ -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 - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#how-to-submit-a-change'>How to Submit a Change</ulink>" - section in The Yocto Project Development Manual. + "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a Change</ulink>" + section in the Yocto Project Development Manual. </para> </section> diff --git a/documentation/poky-ref-manual/technical-details.xml b/documentation/poky-ref-manual/technical-details.xml index 840c9e3..af62ee4 100644 --- a/documentation/poky-ref-manual/technical-details.xml +++ b/documentation/poky-ref-manual/technical-details.xml @@ -1,5 +1,7 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > + <chapter id='technical-details'> <title>Technical Details</title> @@ -31,16 +33,16 @@ Configuration data acts as the glue to bind everything together.</para></listitem> </itemizedlist> For more information on data, see the - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-terms'>Yocto Project Terms</ulink>" - section in The Yocto Project Development Manual. + "<ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-terms'>Yocto Project Terms</ulink>" + section in the Yocto Project Development Manual. </para> <para> BitBake knows how to combine multiple data sources together and refers to each data source as a layer. For information on layers, see the - "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" - section of the Yocto Project Development Manual. + "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and + Creating Layers</ulink>" section of the Yocto Project Development Manual. </para> <para> @@ -562,7 +564,7 @@ <note> For an example of a commit that makes a cosmetic change to invalidate a shared state, see this - <ulink url='http://git.yoctoproject.org/cgit.cgi/poky/commit/meta/classes/package.bbclass?id=737f8bbb4f27b4837047cb9b4fbfe01dfde36d54'>commit</ulink>. + <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/commit/meta/classes/package.bbclass?id=737f8bbb4f27b4837047cb9b4fbfe01dfde36d54'>commit</ulink>. </note> </section> </section> @@ -623,10 +625,10 @@ <para> In this example, the first line locates a file in - <filename><link linkend='var-S'>S</link>/src/ls.c</filename>. + <filename>${S}/src/ls.c</filename>. The second line refers to a file in <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>, which is the parent - of <filename>S</filename>. + of <filename><link linkend='var-S'>S</link></filename>. </para> <para> 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 8dddb7a..c80b080 100644 --- a/documentation/poky-ref-manual/usingpoky.xml +++ b/documentation/poky-ref-manual/usingpoky.xml @@ -1,5 +1,7 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > + <chapter id='usingpoky'> <title>Using the Yocto Project</title> @@ -15,7 +17,7 @@ <para> You can find general information on how to build an image using the Yocto Project in the - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" + "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" 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 @@ <filename class="directory">tmp/deploy/images</filename>. For information on how to run pre-built images such as <filename>qemux86</filename> and <filename>qemuarm</filename>, see the - "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" - section in The Yocto Project Quick Start. + "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" + section in the Yocto Project Quick Start. For information about how to install these images, see the documentation for your particular board/machine. </para> |