From 9dc84b77ecfbb69b1dce93ccce7140cfa54eee66 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 6 Feb 2012 15:29:08 -0600 Subject: documentation: Cross-referencing section fixed for consistency. (From yocto-docs rev: 8e861c6fc07aefa81ff65e3542de855116e14969) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/poky-ref-manual/development.xml | 25 ++++++++---------- documentation/poky-ref-manual/faq.xml | 10 ++++---- documentation/poky-ref-manual/introduction.xml | 8 +++--- documentation/poky-ref-manual/ref-bitbake.xml | 12 ++++----- documentation/poky-ref-manual/ref-classes.xml | 4 +-- documentation/poky-ref-manual/ref-images.xml | 14 +++++----- documentation/poky-ref-manual/ref-structure.xml | 8 +++--- documentation/poky-ref-manual/ref-variables.xml | 30 ++++++++++++---------- documentation/poky-ref-manual/resources.xml | 14 ++++------ .../poky-ref-manual/technical-details.xml | 16 +++++------- documentation/poky-ref-manual/usingpoky.xml | 18 +++++-------- 11 files changed, 70 insertions(+), 89 deletions(-) (limited to 'documentation/poky-ref-manual') diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml index 934b88efd1..e771b05d7d 100644 --- a/documentation/poky-ref-manual/development.xml +++ b/documentation/poky-ref-manual/development.xml @@ -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 - Reference: Images for a listing of the image + See the + "Reference: Images" appendix for a listing of the image types that Yocto Project supports. @@ -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 - - "Working Within Eclipse" chapter in the - - "Application Development Toolkit (ADT) User's Guide." + "Working Within Eclipse" + chapter in The Yocto Project Application Development Toolkit (ADT) User's Guide. @@ -102,8 +100,8 @@ External Development Using the QEMU Emulator Running Poky QEMU images is covered in the - - Yocto Project Quick Start in the "A Quick Test Run" section. + "A Quick Test Run" + section of The Yocto Project Quick Start. The QEMU images shipped with the Yocto Project contain complete toolchains @@ -210,9 +208,8 @@ For a review of the skills used in this section, see the - BitBake and - Running Specific Tasks sections - in this manual. + "BitBake" and + "Running Specific Tasks" sections. @@ -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 Reference: Images for a description of these + See the "Reference: Images" appendix for a description of these images. You can find information on GDB at . @@ -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 Launching GDB - on the Host Computer section covers how to create such a directory with + The "Launching GDB on the Host Computer" + 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. diff --git a/documentation/poky-ref-manual/faq.xml b/documentation/poky-ref-manual/faq.xml index a526f619b8..4cf52443c1 100644 --- a/documentation/poky-ref-manual/faq.xml +++ b/documentation/poky-ref-manual/faq.xml @@ -384,9 +384,9 @@ - You need to create a form factor file as described in - "Miscellaneous Recipe Files" - and set the HAVE_TOUCHSCREEN variable equal to one as follows: + You need to create a form factor file as described in the + "Miscellaneous Recipe Files" + section and set the HAVE_TOUCHSCREEN variable equal to one as follows: HAVE_TOUCHSCREEN=1 @@ -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 "Miscellaneous Recipe Files" - for information on creating these types of miscellaneous recipe files. + See the "Miscellaneous Recipe Files" + section for information on creating these types of miscellaneous recipe files. For example, add the following files to your layer: diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml index 016ddc827b..fd98c3248b 100644 --- a/documentation/poky-ref-manual/introduction.xml +++ b/documentation/poky-ref-manual/introduction.xml @@ -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 - - Getting Setup section in - - The Yocto Project Development Manual. + For information on both these methods, see the + "Getting Setup" + section in The Yocto Project Development Manual. diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml index ffdda431f5..dc99c5494c 100644 --- a/documentation/poky-ref-manual/ref-bitbake.xml +++ b/documentation/poky-ref-manual/ref-bitbake.xml @@ -207,10 +207,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. @@ -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 BB_HASHBASE_WHITELIST - example in Checksums (Signatures). + example in the "Checksums (Signatures)" section. @@ -401,8 +399,8 @@ Options: This feature works using the SRCREV variable. See the - Development Within Yocto Project for a Package that Uses - an External SCM section for more information. + "Development Within Yocto Project for a Package that Uses + an External SCM" section for more information. diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml index 9eb0901aff..9238ba2406 100644 --- a/documentation/poky-ref-manual/ref-classes.xml +++ b/documentation/poky-ref-manual/ref-classes.xml @@ -253,8 +253,8 @@ This class adds the devshell task. Distribution policy dictates whether to include this class as the Yocto Project does. - See the Development Within a Development Shell section + See the + "Development Within a Development Shell" section for more information about using devshell. diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml index 519f1c7675..1e0b601a4a 100644 --- a/documentation/poky-ref-manual/ref-images.xml +++ b/documentation/poky-ref-manual/ref-images.xml @@ -69,9 +69,8 @@ core-image-lsb-sdk: A core-image-lsb that includes everything in meta-toolchain but also includes development headers and libraries to form a complete standalone SDK. - See the - External Development Using the Poky SDK section for more information. - + See the "External Development Using the Meta-Toolchain" + section for more information. core-image-clutter: An image with support for the Open GL-based toolkit Clutter, which enables development of rich and animated graphical user interfaces. @@ -89,9 +88,8 @@ core-image-sato-sdk: A core-image-sato image that includes everything in meta-toolchain. The image also includes development headers and libraries to form a complete standalone SDK. - See the - External Development Using the Poky SDK section for more information. - + See the "External Development Using the Meta-Toolchain" + section for more information. core-image-rt: A core-image-minimal image plus a real-time test suite and tools appropriate for real-time use. @@ -100,8 +98,8 @@ meta-toolchain. The image also includes development headers and libraries to form a complete stand-alone SDK. - See the External Development - Using the Poky SDK section for more information. + See the "External Development Using the Meta-Toolchain" + section for more information. core-image-gtk-directfb: An image that uses gtk+ over directfb instead of X11. diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index f35e2d7400..d12604536c 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml @@ -14,10 +14,8 @@ For information on how to establish the Yocto Project files on your local development system, see the - - Getting Setup section in the - - The Yocto Project Development Manual. + "Getting Setup" + section in The Yocto Project Development Manual.
@@ -363,7 +361,7 @@ This directory contains intermediate packaging data that is used later in the packaging process. - For more information, see package.bbclass. + For more information, see the "Packaging - package*.bbclass" section.
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 529c5ec597..2540a9df01 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml @@ -375,9 +375,9 @@ DISTRO_PN_ALIAS Alias names used for the recipe in various Linux distributions. - See the section - "Handling a Package Name Alias" in the Yocto Project Development Manual - for more information. + See the + "Handling a Package Name Alias" + section in the Yocto Project Development Manual for more information. @@ -421,9 +421,9 @@ 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 - this entry in - The FAQ appendix of this manual. + For additional information on how the build process gets source files, see the + "FAQ" + appendix. @@ -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 EXTRA_IMAGE_FEATURES variable. - See the Reference: Images section for the + See the "Reference: Images" section for the list of features present in images built by the Yocto Project. @@ -1022,7 +1022,7 @@ This variable is similar to the - MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS + MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS 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 @@ This variable is similar to the - MACHINE_ESSENTIAL_EXTRA_RDEPENDS + MACHINE_ESSENTIAL_EXTRA_RDEPENDS 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 @@ This variable is similar to the - MACHINE_EXTRA_RRECOMMENDS + MACHINE_EXTRA_RRECOMMENDS 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 @@ This variable is similar to the - MACHINE_EXTRA_RDEPENDS + MACHINE_EXTRA_RDEPENDS 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 - RDEPENDS variable. + RDEPENDS variable. The Yocto Project build process automatically installs the list of packages @@ -1468,8 +1468,10 @@ The path to unpacked sources. - By default, this path is - "${WORKDIR}/${PN}-${PV}". + By default, this path is as follows: + + ${WORKDIR}/${PN}-${PV} + diff --git a/documentation/poky-ref-manual/resources.xml b/documentation/poky-ref-manual/resources.xml index 998a09f3c4..a3b5e0806f 100644 --- a/documentation/poky-ref-manual/resources.xml +++ b/documentation/poky-ref-manual/resources.xml @@ -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 - Yocto Project Release list item in - The Yocto - Project Development Manual. + see the "Yocto Project Release" + list item in The Yocto Project Development Manual. @@ -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 - - How to Submit a Change in - - The Yocto Project Development Manual. + For information on how to do both, see the + "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 833b355336..eb64280734 100644 --- a/documentation/poky-ref-manual/technical-details.xml +++ b/documentation/poky-ref-manual/technical-details.xml @@ -31,24 +31,22 @@ 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 - "BitBake Layers" section of the Yocto Project Development Manual. + "BitBake Layers" + section of the Yocto Project Development Manual. Following are some brief details on these core components. For more detailed information on these components see the - 'Reference: Directory Structure' - appendix. + "Reference: Directory Structure" appendix.
@@ -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 - Preferences and Providers section. + "Preferences and Providers" section. @@ -129,7 +127,7 @@ between metadata files. An example is the Autotools class, which contains common settings for any application that Autotools uses. - The Reference: Classes appendix provides details + The "Reference: Classes" appendix provides details about common classes and how to use them.
diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml index 7fe60215ab..8dddb7a755 100644 --- a/documentation/poky-ref-manual/usingpoky.xml +++ b/documentation/poky-ref-manual/usingpoky.xml @@ -15,10 +15,8 @@ You can find general information on how to build an image using the Yocto Project in the - - Building an Image section of the - - Yocto Project Quick Start. + "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. @@ -60,14 +58,14 @@ files. Or, the target can be the name of a recipe for a specific piece of software such as busybox. - For more details about the images Yocto Project supports, see the - 'Reference: Images' appendix. + For more details about the images the Yocto Project supports, see the + "Reference: Images" appendix. Building an image without GNU Public License Version 3 (GPLv3) components is only supported for minimal and base images. - See 'Reference: Images' for more information. + See the "Reference: Images" appendix for more information. @@ -93,10 +91,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