diff options
authorScott Rifenbark <>2012-01-06 15:13:34 -0600
committerRichard Purdie <>2012-03-08 12:07:36 -0800
commit39b508fb85c1079e40bd8b81fe9d85ab2cdda186 (patch)
parentbc911b8af7cbc4dcfd9b0493a97e9fbd5d34b573 (diff)
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 <>
2 files changed, 91 insertions, 44 deletions
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 @@
+<!ENTITY ECLIPSE_INDIGO_CDT_URL "&ECLIPSE_DL_URL;tools/cdt/releases/indigo">
+<!ENTITY YOCTO_POKY_URL "&YOCTO_DL_URL;/releases/poky/">
+<!ENTITY YOCTO_RELEASE_DL_URL "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;">
+<!ENTITY YOCTO_PYTHON-i686_DL_URL "&YOCTO_DL_URL;/releases/miscsupport/yocto-&DISTRO;-python-nativesdk/python-nativesdk-standalone-i686.tar.bz2">
+<!ENTITY YOCTO_PYTHON-x86_64_DL_URL "&YOCTO_DL_URL;/releases/miscsupport/yocto-&DISTRO;-python-nativesdk/python-nativesdk-standalone-x86_64.tar.bz2">
+<!ENTITY YOCTO_DOCS_QS_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/yocto-project-qs/yocto-project-qs.html">
+<!ENTITY YOCTO_DOCS_REF_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/poky-ref-manual/poky-ref-manual.html">
+<!ENTITY YOCTO_DOCS_KERNEL_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/kernel-manual/kernel-manual.html">
+<!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env">
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 @@
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<article id='intro'>
<imagedata fileref="figures/yocto-project-transp.png" width="6in" depth="1in" align="right" scale="25" />
<section id='fake-title'>
<title>Yocto Project Quick Start</title>
- <para>Copyright &copy; 2010-2011 Linux Foundation</para>
+ <para>Copyright &copy; &COPYRIGHT_YEAR; Linux Foundation</para>
<section id='welcome'>
@@ -28,24 +29,24 @@
For complete information on the Yocto Project, you should check out the
- <ulink url=''>Yocto Project Website</ulink>.
+ <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>.
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 <ulink url=''>Yocto Project FAQ</ulink> and
+ at <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>Yocto Project FAQ</ulink> and
the FAQ appendix located in
- <ulink url=''>
+ <ulink url='&YOCTO_DOCS_REF_URL;'>
The Yocto Project Reference Manual</ulink> helpful.
Due to production processes, there could be differences between the Yocto Project
documentation bundled in the release tarball and the
- <ulink url=''>
+ <ulink url='&YOCTO_DOCS_QS_URL;'>
Yocto Project Quick Start</ulink> on
- the <ulink url=''>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.
@@ -156,11 +157,11 @@
For a list of the distributions under validation and their status, see the
- <ulink url=''>Distribution
+ <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution
Support</ulink> wiki page.
For notes about using the Yocto Project on a RHEL 4-based host, see the
- <ulink url=''>BuildingOnRHEL4</ulink>
+ <ulink url='&YOCTO_WIKI_URL;/wiki/BuildingOnRHEL4'>BuildingOnRHEL4</ulink>
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
- <ulink url=';action=historysubmit&amp;diff=4309&amp;okdid=4225'>OE and Your Distro</ulink> and
- <ulink url=';action=historysubmit&amp;diff=4311&amp;oldid=4251'>Required Software</ulink>
+ <ulink url='&OE_HOME_URL;/index.php?title=OEandYourDistro&amp;action=historysubmit&amp;diff=4309&amp;okdid=4225'>OE and Your Distro</ulink> and
+ <ulink url='&OE_HOME_URL;/index.php?title=Required_software&amp;action=historysubmit&amp;diff=4311&amp;oldid=4251'>Required Software</ulink>
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 <ulink url=''>Yocto Project Bugzilla</ulink>
+ When you do, please go to <ulink url='&YOCTO_BUGZILLA_URL;'>Yocto Project Bugzilla</ulink>
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
- <ulink url="">Yocto Project Download page</ulink>.
+ <ulink url="&YOCTO_HOME_URL;/download">Yocto Project Download page</ulink>.
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
- <ulink url=""></ulink>.
+ <ulink url="&YOCTO_AB_NIGHTLY_URL;"></ulink>.
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
- "<ulink url=''>Yocto
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto
Project Release</ulink>" item in
- <ulink url=''>The Yocto Project
+ <ulink url='&YOCTO_DOCS_DEV_URL;'>The Yocto Project
Development Manual</ulink>.
@@ -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
- <ulink url=''>
+ <ulink url='&YOCTO_DOCS_REF_URL;'>
The Yocto Project Reference Manual</ulink>.
<literallayout class='monospaced'>
- $ wget
- $ 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
<filename>wget</filename> command.
Alternatively, you can go to the
- <ulink url=''>Yocto Project website</ulink>
+ <ulink url='&YOCTO_HOME_URL;/download'>Yocto Project website</ulink>
Downloads page to retrieve the tarball.</para></listitem>
<listitem><para>The second command extracts the files from the tarball and places
them into a directory named <filename>poky-edison-6.0</filename> in the current
@@ -397,8 +398,8 @@
Another couple of variables of interest are the
- <ulink url=''><filename>BB_NUMBER_THREADS</filename></ulink> and the
- <ulink url=''><filename>PARALLEL_MAKE</filename></ulink> variables.
+ <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> and the
+ <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> 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
- <filename><ulink url=''><filename>PACKAGE_CLASSES</filename></ulink></filename> variable.
+ <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable.
For additional package manager selection information, see
- "<ulink url=''>Packaging - <filename>package*.bbclass</filename></ulink>" in
- <ulink url=''>
+ "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>" in
+ <ulink url='&YOCTO_DOCS_REF_URL;'>
The Yocto Project Reference Manual</ulink>.
@@ -423,15 +424,15 @@
<filename>core-image-sato</filename> in this example.
For information on the <filename>-k</filename> option use the
<filename>bitbake --help</filename> command or see the
- "<ulink url=''>BitBake</ulink>" section in
- <ulink url=''>The Yocto Project Reference Manual</ulink>.
+ "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" section in
+ <ulink url='&YOCTO_DOCS_REF_URL;'>The Yocto Project Reference Manual</ulink>.
<literallayout class='monospaced'>
$ bitbake -k core-image-sato
BitBake requires Python 2.6 or 2.7. For more information on this requirement,
see the FAQ appendix in
- <ulink url=''>
+ <ulink url='&YOCTO_DOCS_REF_URL;'>
The Yocto Project Reference Manual</ulink>.
The final command runs the image:
@@ -485,7 +486,7 @@
You can download the pre-built toolchain, which includes the <filename>runqemu</filename>
script and support files, from the appropriate directory under
- <ulink url=''></ulink>.
+ <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>.
Toolchains are available for 32-bit and 64-bit development systems from the
<filename>i686</filename> and <filename>x86_64</filename> directories, respectively.
Each type of development system supports five target architectures.
@@ -513,7 +514,7 @@
<literallayout class='monospaced'>
- 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 @@
<literallayout class='monospaced'>
$ 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
- "<ulink url=''>Using a Cross-Toolchain Tarball</ulink>" and
- "<ulink url=''>Using BitBake and the Yocto Project Build Tree</ulink>" sections in
- <ulink url=''>The Yocto Project
+ "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" and
+ "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Yocto Project Build Tree</ulink>" sections in
+ <ulink url='&YOCTO_DOCS_ADT_URL;'>The Yocto Project
Application Development Toolkit (ADT) User's Guide</ulink>.
@@ -544,7 +545,7 @@
You can download the pre-built Linux kernel suitable for running in the QEMU emulator from
- <ulink url=''></ulink>.
+ <ulink url='&YOCTO_QEMU_DL_URL;'></ulink>.
Be sure to use the kernel that matches the architecture you want to simulate.
Download areas exist for the five supported machine architectures:
<filename>qemuarm</filename>, <filename>qemumips</filename>, <filename>qemuppc</filename>,
@@ -565,8 +566,8 @@
You can learn more about downloading a Yocto Project kernel in the
- "<ulink url=''>Linux Yocto Kernel</ulink>" section of
- <ulink url=''>The
+ "<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink>" section of
+ <ulink url='&YOCTO_DOCS_DEV_URL;'>The
Yocto Project Development Manual</ulink>.
@@ -576,7 +577,7 @@
You can also download the filesystem image suitable for your target architecture from
- <ulink url=''></ulink>.
+ <ulink url='&YOCTO_QEMU_DL_URL;'></ulink>.
Again, be sure to use the filesystem that matches the architecture you want
to simulate.
@@ -596,7 +597,7 @@
&lt;<emphasis>profile</emphasis>&gt; 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
- <ulink url=''>Reference: Images</ulink> in the Yocto Project Reference Manual.
+ <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink> in the Yocto Project Reference Manual.
&lt;<emphasis>arch</emphasis>&gt; 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.
<literallayout class='monospaced'>
- $ source /opt/poky/1.1/environment-setup-&lt;<emphasis>arch</emphasis>&gt;-poky-linux-&lt;<emphasis>if</emphasis>&gt;
+ $ source &YOCTO_ADTPATH_DIR;/environment-setup-&lt;<emphasis>arch</emphasis>&gt;-poky-linux-&lt;<emphasis>if</emphasis>&gt;
&lt;<emphasis>arch</emphasis>&gt; 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.
<literallayout class='monospaced'>
- $ 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 \