documentation: Cross-referencing section fixed for consistency.

(From yocto-docs rev: 8e861c6fc07aefa81ff65e3542de855116e14969)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2012-02-06 15:29:08 -06:00 committed by Richard Purdie
parent e8a6970b0c
commit 9dc84b77ec
12 changed files with 74 additions and 94 deletions

View File

@ -30,10 +30,8 @@
<note>
The information here does not provide an example of how to create a BSP.
For examples on how to create a BSP, see the
<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#dev-manual-bsp-appendix'>
BSP Development Example</ulink> in
<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>
The Yocto Project Development Manual</ulink>.
"<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#dev-manual-bsp-appendix'>BSP Development Example</ulink>"
section in The Yocto Project Development Manual.
You can also see the
<ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'>
wiki page</ulink>.
@ -100,7 +98,8 @@
"
</literallayout>
For more detailed information on layers, see the
"<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#usingpoky-changes-layers'>BitBake Layers</ulink>" section of the Yocto Project Reference Manual.
"<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#usingpoky-changes-layers'>BitBake Layers</ulink>"
section of the Yocto Project Reference Manual.
You can also see the detailed examples in the appendices of
<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>
The Yocto Project Development Manual</ulink>.

View File

@ -24,8 +24,8 @@
The Yocto Project also provides images that have toolchains for supported
architectures included within the image.
This allows you to compile, debug, or profile applications directly on the target device.
See
<xref linkend='ref-images'>Reference: Images</xref> for a listing of the image
See the
"<link linkend='ref-images'>Reference: Images</link>" appendix for a listing of the image
types that Yocto Project supports.
</para>
<para>
@ -91,10 +91,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
<ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html'>
"Application Development Toolkit (ADT) User's Guide."</ulink>
"<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.
</para>
</section>
@ -102,8 +100,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">
Yocto Project Quick Start</ulink> in the "A Quick Test Run" section.
"<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.
</para>
<para>
The QEMU images shipped with the Yocto Project contain complete toolchains
@ -210,9 +208,8 @@
<para>
For a review of the skills used in this section, see the
<link linkend="usingpoky-components-bitbake">BitBake</link> and
<link linkend="usingpoky-debugging-taskrunning">Running Specific Tasks</link> sections
in this manual.
"<link linkend='usingpoky-components-bitbake'>BitBake</link>" and
"<link linkend='usingpoky-debugging-taskrunning'>Running Specific Tasks</link>" sections.
</para>
</section>
@ -332,7 +329,7 @@
It also allows you to perform post-mortem style analysis of program crashes.
GDB is available as a package within the Yocto Project and by default is
installed in sdk images.
See <xref linkend='ref-images'>Reference: Images</xref> for a description of these
See the "<link linkend='ref-images'>Reference: Images</link>" appendix for a description of these
images.
You can find information on GDB at <ulink url="http://sourceware.org/gdb/"/>.
</para>
@ -764,8 +761,8 @@
is not always necessary to actually have them on the device for OProfile use.
All that is needed is a copy of the filesystem with the debug symbols present
on the viewer system.
The <link linkend='platdev-gdb-remotedebug-launch-gdb'>Launching GDB
on the Host Computer</link> section covers how to create such a directory with
The "<link linkend='platdev-gdb-remotedebug-launch-gdb'>Launching GDB on the Host Computer</link>"
section covers how to create such a directory with
the Yocto Project and how to use the OProfileUI Settings dialog to specify the location.
If you specify the directory, it will be used when the file checksums
match those on the system you are profiling.

View File

@ -384,9 +384,9 @@
</question>
<answer>
<para>
You need to create a form factor file as described in
<xref linkend='bsp-filelayout-misc-recipes'>"Miscellaneous Recipe Files"</xref>
and set the <filename>HAVE_TOUCHSCREEN</filename> variable equal to one as follows:
You need to create a form factor file as described in the
"<link linkend='bsp-filelayout-misc-recipes'>Miscellaneous Recipe Files</link>"
section and set the <filename>HAVE_TOUCHSCREEN</filename> variable equal to one as follows:
<literallayout class='monospaced'>
HAVE_TOUCHSCREEN=1
</literallayout>
@ -406,8 +406,8 @@
automatically bring up network interfaces.
Therefore, you will need to add a BSP-specific netbase that includes an interfaces
file.
See <xref linkend='bsp-filelayout-misc-recipes'>"Miscellaneous Recipe Files"</xref>
for information on creating these types of miscellaneous recipe files.
See the "<link linkend='bsp-filelayout-misc-recipes'>Miscellaneous Recipe Files</link>"
section for information on creating these types of miscellaneous recipe files.
</para>
<para>
For example, add the following files to your layer:

View File

@ -128,11 +128,9 @@
Development using the Yocto Project requires a local copy of the Yocto Project files.
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
<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#getting-setup'>
Getting Setup</ulink> section in
<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>
The Yocto Project Development Manual</ulink>.
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>"
section in The Yocto Project Development Manual.
</para>
</section>

View File

@ -207,10 +207,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
<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'>
Yocto Project Quick Start</ulink> for more information.
"<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.
</para>
<para>
@ -301,7 +299,7 @@
variable so that the shared state code ignores the dependency when it creates
checksums.
For information on this process, see the <filename>BB_HASHBASE_WHITELIST</filename>
example in <xref linkend='checksums'>Checksums (Signatures)</xref>.
example in the "<link linkend='checksums'>Checksums (Signatures)</link>" section.
</note>
</section>
@ -401,8 +399,8 @@ Options:
This feature works using the <filename><link linkend='var-SRCREV'>SRCREV</link></filename>
variable.
See the
<link linkend='platdev-appdev-srcrev'>Development Within Yocto Project for a Package that Uses
an External SCM</link> section for more information.
"<link linkend='platdev-appdev-srcrev'>Development Within Yocto Project for a Package that Uses
an External SCM</link>" section for more information.
</para>
</section>

View File

@ -253,8 +253,8 @@
<para>
This class adds the <filename>devshell</filename> task.
Distribution policy dictates whether to include this class as the Yocto Project does.
See the <link
linkend='platdev-appdev-devshell'>Development Within a Development Shell</link> section
See the
"<link linkend='platdev-appdev-devshell'>Development Within a Development Shell</link>" section
for more information about using devshell.
</para>
</section>

View File

@ -69,9 +69,8 @@
<listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis>
A <filename>core-image-lsb</filename> that includes everything in meta-toolchain
but also includes development headers and libraries to form a complete standalone SDK.
See the <link linkend='platdev-appdev-external-sdk'>
External Development Using the Poky SDK</link> section for more information.
</para></listitem>
See the "<link linkend='platdev-appdev-external-sdk'>External Development Using the Meta-Toolchain</link>"
section for more information.</para></listitem>
<listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis>
An image with support for the Open GL-based toolkit Clutter, which enables development of
rich and animated graphical user interfaces.</para></listitem>
@ -89,9 +88,8 @@
<listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis>
A <filename>core-image-sato</filename> image that includes everything in meta-toolchain.
The image also includes development headers and libraries to form a complete standalone SDK.
See the <link linkend='platdev-appdev-external-sdk'>
External Development Using the Poky SDK</link> section for more information.
</para></listitem>
See the "<link linkend='platdev-appdev-external-sdk'>External Development Using the Meta-Toolchain</link>"
section for more information.</para></listitem>
<listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis>
A <filename>core-image-minimal</filename> image plus a real-time test suite and
tools appropriate for real-time use.</para></listitem>
@ -100,8 +98,8 @@
<filename>meta-toolchain</filename>.
The image also includes development headers and libraries to form a complete
stand-alone SDK.
See the <link linkend='platdev-appdev-external-sdk'> External Development
Using the Poky SDK</link> section for more information.</para></listitem>
See the "<link linkend='platdev-appdev-external-sdk'>External Development Using the Meta-Toolchain</link>"
section for more information.</para></listitem>
<listitem><para><emphasis><filename>core-image-gtk-directfb</filename>:</emphasis>
An image that uses <filename>gtk+</filename> over <filename>directfb</filename>
instead of X11.

View File

@ -14,10 +14,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
<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>
The Yocto Project Development Manual</ulink>.
"<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.
</para>
<section id='structure-core'>
@ -363,7 +361,7 @@
<para>
This directory contains intermediate packaging data that is used later in the packaging process.
For more information, see <link linkend='ref-classes-package'>package.bbclass</link>.
For more information, see the "<link linkend='ref-classes-package'>Packaging - package*.bbclass</link>" section.
</para>
</section>

View File

@ -375,9 +375,9 @@
<glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm>
<glossdef>
<para>Alias names used for the recipe in various Linux distributions.</para>
<para>See the section
"<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#usingpoky-configuring-DISTRO_PN_ALIAS'>Handling a Package Name Alias</ulink>" in the Yocto Project Development Manual
for more information.</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>
</glossdef>
</glossentry>
@ -421,9 +421,9 @@
<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
<link linkend='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>this entry</link> in
The FAQ appendix of this manual.
For additional information on how the build process gets source files, 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>
</glossdef>
@ -635,7 +635,7 @@
Typically, you configure this variable in image recipes.
Note that you can add extra features to the image by using the
<filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable.
See the <link linkend="ref-features-image">Reference: Images</link> section for the
See the "<link linkend="ref-features-image">Reference: Images</link>" section for the
list of features present in images built by the Yocto Project.</para>
</glossdef>
</glossentry>
@ -1022,7 +1022,7 @@
</para>
<para>
This variable is similar to the
<link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link>
<filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename>
variable with the exception that the package being built has a build
dependency on the variable's list of packages.
In other words, the image will not build if a file in this list is not found.
@ -1052,7 +1052,7 @@
</para>
<para>
This variable is similar to the
<link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link>
<filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link></filename>
variable with the exception that the package being built does not have a build
dependency on the variable's list of packages.
In other words, the image will build if a file in this list is not found.
@ -1100,7 +1100,7 @@
</para>
<para>
This variable is similar to the
<link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link>
<filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename>
variable with the exception that the package being built has a build
dependency on the variable's list of packages.
In other words, the image will not build if a file in this list is not found.
@ -1137,7 +1137,7 @@
</para>
<para>
This variable is similar to the
<link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link>
<filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></filename>
variable with the exception that the package being built does not have a build
dependency on the variable's list of packages.
In other words, the image will build if a file in this list is not found.
@ -1426,7 +1426,7 @@
The package being built does not depend on this list of packages in
order to successfully build, but needs them for the extended usability.
To specify runtime dependencies for packages, see the
<link linkend='var-RDEPENDS'>RDEPENDS</link> variable.
<filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variable.
</para>
<para>
The Yocto Project build process automatically installs the list of packages
@ -1468,8 +1468,10 @@
<glossdef>
<para>
The path to unpacked sources.
By default, this path is
"${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}".
By default, this path is as follows:
<literallayout class='monospaced'>
${<link linkend='var-WORKDIR'>WORKDIR</link>}/${<link linkend='var-PN'>PN</link>}-${<link linkend='var-PV'>PV</link>}
</literallayout>
</para>
</glossdef>
</glossentry>

View File

@ -10,10 +10,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
<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The Yocto
Project Development Manual</ulink>.
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.
</para>
</section>
@ -96,11 +94,9 @@
The Yocto Project gladly accepts contributions.
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
<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#how-to-submit-a-change'>
How to Submit a Change</ulink> in
<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>
The Yocto Project Development Manual</ulink>.
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.
</para>
</section>

View File

@ -31,24 +31,22 @@
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
<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>
The Yocto Project Development Manual</ulink>.
"<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.
</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#usingpoky-changes-layers'>BitBake Layers</ulink>" section of the Yocto Project Development Manual.
"<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#usingpoky-changes-layers'>BitBake Layers</ulink>"
section of the Yocto Project Development Manual.
</para>
<para>
Following are some brief details on these core components.
For more detailed information on these components see the
<link linkend='ref-structure'>'Reference: Directory Structure'</link>
appendix.
"<link linkend='ref-structure'>Reference: Directory Structure</link>" appendix.
</para>
<section id='usingpoky-components-bitbake'>
@ -78,7 +76,7 @@
BitBake chooses the one selected by the distribution configuration.
You can get more details about how BitBake chooses between different
target versions and providers in the
<link linkend='ref-bitbake-providers'>Preferences and Providers</link> section.
"<link linkend='ref-bitbake-providers'>Preferences and Providers</link>" section.
</para>
<para>
@ -129,7 +127,7 @@
between metadata files.
An example is the Autotools class, which contains
common settings for any application that Autotools uses.
The <link linkend='ref-classes'>Reference: Classes</link> appendix provides details
The "<link linkend='ref-classes'>Reference: Classes</link>" appendix provides details
about common classes and how to use them.
</para>
</section>

View File

@ -15,10 +15,8 @@
<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> section of the
<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'>
Yocto Project Quick Start</ulink>.
"<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#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.
</para>
@ -60,14 +58,14 @@
files.
Or, the target can be the name of a recipe for a specific piece of software such as
<application>busybox</application>.
For more details about the images Yocto Project supports, see the
<link linkend="ref-images">'Reference: Images'</link> appendix.
For more details about the images the Yocto Project supports, see the
"<link linkend="ref-images">Reference: Images</link>" appendix.
</para>
<note>
Building an image without GNU Public License Version 3 (GPLv3) components is
only supported for minimal and base images.
See <link linkend='ref-images'>'Reference: Images'</link> for more information.
See the "<link linkend='ref-images'>Reference: Images</link>" appendix for more information.
</note>
</section>
@ -93,10 +91,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
<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'>
Yocto Project Quick Start</ulink>.
"<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.
For information about how to install these images, see the documentation for your
particular board/machine.
</para>