From 684c35b7aa0898f95ab70a5982ef74ce98107d93 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 10 Nov 2011 10:28:25 -0800 Subject: documentation: Changed all manual links to point to "latest" There are many references to YP documentation throughout the YP manual set. They used to have hard-coded links to the current release (e.g. yoctoproject.org/docs/1.1 for Edison). This created a situation where if you went to a document on the website and clicked on a external reference to another manual, you would redirect to the current manual on the website. Really, you would want to go to the latest manual, which is one that is under development. Changing the links to "yoctoproject.org/docs/latest" makes the tip of master, which is used for devloping the next release, always have references to the manuals being developed and not back to the stable released set of manuals. This "latest" and "current" scheme for the links is not perfect. What has to happen when the latest set of the manuals freezes and becomes the next stable release, all the links in the docs will need to be changed from "latest" in the URL to the new release number. So for example, all the "latest" occurences would need to be changed to "1.2". Then for the next cycle as development begins again, the links need to be infused with "latest" again. (From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/adt-manual/adt-eclipse.xml | 4 +- documentation/adt-manual/adt-manual.xml | 2 +- documentation/adt-manual/adt-package.xml | 4 +- documentation/adt-manual/adt-prepare.xml | 12 +++--- documentation/bsp-guide/bsp-guide.xml | 2 +- documentation/bsp-guide/bsp.xml | 10 ++--- .../dev-manual/dev-manual-bsp-appendix.xml | 6 +-- documentation/dev-manual/dev-manual-intro.xml | 12 +++--- documentation/dev-manual/dev-manual-model.xml | 46 +++++++++++----------- documentation/dev-manual/dev-manual-newbie.xml | 10 ++--- documentation/dev-manual/dev-manual-start.xml | 10 ++--- documentation/dev-manual/dev-manual.xml | 2 +- documentation/kernel-manual/kernel-concepts.xml | 8 ++-- documentation/kernel-manual/kernel-doc-intro.xml | 8 ++-- documentation/kernel-manual/kernel-how-to.xml | 22 +++++------ documentation/kernel-manual/kernel-manual.xml | 2 +- documentation/poky-ref-manual/development.xml | 6 +-- documentation/poky-ref-manual/extendpoky.xml | 4 +- documentation/poky-ref-manual/introduction.xml | 10 ++--- documentation/poky-ref-manual/poky-ref-manual.xml | 2 +- documentation/poky-ref-manual/ref-bitbake.xml | 4 +- documentation/poky-ref-manual/ref-structure.xml | 4 +- documentation/poky-ref-manual/resources.xml | 8 ++-- documentation/poky-ref-manual/usingpoky.xml | 12 +++--- .../yocto-project-qs/yocto-project-qs.xml | 38 +++++++++--------- 25 files changed, 124 insertions(+), 124 deletions(-) (limited to 'documentation') diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml index c1b241c567..764f808e7e 100644 --- a/documentation/adt-manual/adt-eclipse.xml +++ b/documentation/adt-manual/adt-eclipse.xml @@ -349,8 +349,8 @@ The pull-down menu should have the supported architectures. If the architecture you need is not listed in the menu, you will need to build the image. - See the "Building an Image" section of the - + See the "Building an Image" section of the + The Yocto Project Quick Start for more information. diff --git a/documentation/adt-manual/adt-manual.xml b/documentation/adt-manual/adt-manual.xml index e6f3116b3a..7b6b73f45e 100644 --- a/documentation/adt-manual/adt-manual.xml +++ b/documentation/adt-manual/adt-manual.xml @@ -58,7 +58,7 @@ Due to production processes, there could be differences between the Yocto Project documentation bundled in the release tarball and the - + Application Developer's Toolkit (ADT) User's Guide on the Yocto Project website. For the latest version of this manual, see the manual on the website. diff --git a/documentation/adt-manual/adt-package.xml b/documentation/adt-manual/adt-package.xml index c035c2d011..41e62b1446 100644 --- a/documentation/adt-manual/adt-package.xml +++ b/documentation/adt-manual/adt-package.xml @@ -54,8 +54,8 @@ For build performance information related to the PMS, see - Packaging - package*.bbclass - in + Packaging - package*.bbclass + in The Yocto Project Reference Manual. diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml index 3fa59ec19e..098ff75ec7 100644 --- a/documentation/adt-manual/adt-prepare.xml +++ b/documentation/adt-manual/adt-prepare.xml @@ -164,9 +164,9 @@ The ADT Installer requires the libtool package to complete. If you install the recommended packages as described in the - "Packages" + "Packages" section of - + The Yocto Project Quick Start, then you will have libtool installed. @@ -330,9 +330,9 @@ To get the kernel and filesystem images, you either have to build them or download pre-built versions. You can find examples for both these situations in the - "A + "A Quick Test Run" section of - + The Yocto Project Quick Start. @@ -345,8 +345,8 @@ area - and are ideal for experimentation within Yocto Project. For information on the image types you can build using the Yocto Project, see the - "Reference: Images" appendix in - + "Reference: Images" appendix in + The Yocto Project Reference Manual. diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml index 7f06df7110..d5cdd2bd63 100644 --- a/documentation/bsp-guide/bsp-guide.xml +++ b/documentation/bsp-guide/bsp-guide.xml @@ -70,7 +70,7 @@ Due to production processes, there could be differences between the Yocto Project documentation bundled in the release tarball and the - + Board Support Package (BSP) Developer's Guide on the Yocto Project website. For the latest version of this manual, see the manual on the website. diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 8b0d2ab968..329bf87b63 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -30,9 +30,9 @@ The information here does not provide an example of how to create a BSP. For examples on how to create a BSP, see the - + BSP Development Example in - + The Yocto Project Development Manual. You can also see the @@ -100,9 +100,9 @@ " For more detailed information on layers, see the - "BitBake Layers" section of the Yocto Project Reference Manual. + "BitBake Layers" section of the Yocto Project Reference Manual. You can also see the detailed examples in the appendices of - + The Yocto Project Development Manual. @@ -542,7 +542,7 @@ The configuration options will likely end up in that location anyway if the BSP gets added to the Yocto Project. For information on how to add these configurations directly, see - + The Yocto Project Kernel Architecture and Use Manual. In general, however, the Yocto Project maintainers take care of moving the diff --git a/documentation/dev-manual/dev-manual-bsp-appendix.xml b/documentation/dev-manual/dev-manual-bsp-appendix.xml index ed3af67284..7b8dc6ead5 100644 --- a/documentation/dev-manual/dev-manual-bsp-appendix.xml +++ b/documentation/dev-manual/dev-manual-bsp-appendix.xml @@ -238,8 +238,8 @@ meta-mymachine/conf/layer.conf. This file identifies build information needed for the new layer. You can see the - "Layer Configuration File" section in - The Board + "Layer Configuration File" section in + The Board Support Packages (BSP) Development Guide for more information on this configuration file. Basically, we are changing the existing statements to work with our BSP. @@ -578,7 +578,7 @@ The appendix - + Reference: Variables Glossary in the Yocto Project Reference Manual has more information on configuration variables. diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index 3d1b76a004..85eea519ff 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml @@ -69,7 +69,7 @@ Reference material. This type of material resides in an appropriate reference manual. For example, system variables are documented in the - + Yocto Project Reference Manual. Detailed public information that is not specific to the Yocto Project. For example, exhaustive information on how to use Git is covered better through the @@ -90,27 +90,27 @@ The home page for the Yocto Project provides lots of information on the project as well as links to software and documentation. - + The Yocto Project Quick Start: This short document lets you get started with the Yocto Project quickly and start building an image. - + The Yocto Project Reference Manual: This manual is a reference guide to the Yocto Project build component known as "Poky." The manual also contains a reference chapter on Board Support Package (BSP) layout. - + The Yocto Project Application Development Toolkit (ADT) User's Guide: This guide provides information that lets you get going with the ADT to develop projects using the Yocto Project. - + The Yocto Project Board Support Package (BSP) Developer's Guide: This guide defines the structure for BSP components. Having a commonly understood structure encourages standardization. - + The Yocto Project Kernel Architecture and Use Manual: This manual describes the architecture of the Yocto Project kernel and provides some work flow examples. diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 1d45a036c8..f2912b1c1b 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -24,7 +24,7 @@ For a user-space application development example that uses the Eclipse IDE, see the - + The Yocto Project Application Development Toolkit (ADT) User's Guide. @@ -79,8 +79,8 @@ Set up your host development system to support development using the Yocto Project: See the - "The Linux Distributions" and the - "The Packages" sections both + "The Linux Distributions" and the + "The Packages" sections both in the Yocto Project Quick Start for requirements. Establish a local copy of the Yocto Project files on your system: You need to have the Yocto Project files available on your host system. @@ -137,7 +137,7 @@ N450, and Sugar Bay are isolated. When you set up a layer for a new BSP, you should follow a standard layout. This layout is described in the section - "Example Filesystem Layout" section of the Board Support Package (BSP) Development Guide. + "Example Filesystem Layout" section of the Board Support Package (BSP) Development Guide. In the standard layout, you will notice a suggested structure for recipes and configuration information. You can see the standard layout for the Crown Bay BSP in this example by examining the @@ -160,7 +160,7 @@ You need to get the build environment ready by sourcing an environment setup script and you need to be sure two key configuration files are configured appropriately. The entire process for building an image is overviewed in the section - "Building an Image" section of the Yocto Project Quick Start. + "Building an Image" section of the Yocto Project Quick Start. You might want to reference this information. Build the image: The Yocto Project uses the BitBake tool to build images based on the type of image you want to create. @@ -168,8 +168,8 @@ here. The build process supports several types of images to satisfy different needs. See the - "Reference: Images" appendix in the - + "Reference: Images" appendix in the + Yocto Project Reference Manualfor information on supported images. @@ -178,7 +178,7 @@ You can view a video presentation on "Building Custom Embedded Images with Yocto" at Free Electrons. You can also find supplemental information in - + The Board Support Package (BSP) Development Guide. Finally, there is wiki page write up of the example also located @@ -201,7 +201,7 @@ The remainder of this section presents a high-level overview of the Linux Yocto kernel architecture and the steps to modify the Linux Yocto kernel. For a complete discussion of the kernel, see - + The Yocto Project Kernel Architecture and Use Manual. You can reference the appendix "Kernel Modification Example" @@ -349,7 +349,7 @@ Again, for a complete discussion of the Yocto Project kernel's architcture and its branching strategy, - see the + see the The Yocto Project Kernel Architecture and Use Manual. Also, you can reference Modifying the Kernel Source Code @@ -373,8 +373,8 @@ Set up your host development system to support development using the Yocto Project: See - "The Linux Distributions" and - "The Packages" sections both + "The Linux Distributions" and + "The Packages" sections both in the Yocto Project Quick Start for requirements. Establish a local copy of the Yocto Project files on your system: Having the Yocto Project files on your system gives you access to @@ -453,7 +453,7 @@ (local.conf and bblayers.conf) are configured appropriately. The entire process for building an image is overviewed in the - "Building an Image" section of the Yocto Project Quick Start. + "Building an Image" section of the Yocto Project Quick Start. You might want to reference this information. Also, you should look at the detailed examples found in the appendices at at the end of this manual. @@ -464,8 +464,8 @@ here. The build process supports several types of images to satisfy different needs. See the appendix - "Reference: Images" in the - + "Reference: Images" in the + Yocto Project Reference Manual for information on supported images. Make your configuration changes available @@ -517,7 +517,7 @@ provides an overview of the general development process. If you want to see a detailed example of the process as it is used from within the Eclipse IDE, see - + The Application Development Toolkit (ADT) User's Manual. @@ -534,8 +534,8 @@ Prepare the Host System for the Yocto Project: See - "The Linux Distributions" and - "The Packages" sections both + "The Linux Distributions" and + "The Packages" sections both in the Yocto Project Quick Start for requirements.