From 64b9137b43207c0505c4d8c26e654152b5a699da Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 4 Sep 2012 12:05:21 -0700 Subject: [PATCH] documentation: Fixed links to BitBake User Manual Robert P. J. Day pointed out a link in the development manual that was for the BitBake User Manual. The link resolved to an old, non-maintained version of BitBake documentation. According to Richard Purdie, the BitBake docs referenced should be the ones that ship in the bitbake/doc/manual directory of poky. The YP docs had been using a variable named BITBAKE_DOCS_URL that also resolved to the antiquated user manual site. Consequently, there were many links that needed fixed across both the YP Development Manual and the YP Reference Manual. Each of these references now points in general to the bitbake/doc/manual directory in poky for more information. Reported-by: Robert P. J. Day (From yocto-docs rev: 12f77236b602e9ec43e845c8cec060ad342af19c) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-intro.xml | 8 +++++--- documentation/dev-manual/dev-manual-model.xml | 10 ++++++---- documentation/dev-manual/dev-manual-newbie.xml | 8 +++++--- documentation/dev-manual/dev-manual-start.xml | 7 ++++--- documentation/poky-ref-manual/ref-bitbake.xml | 9 ++++++--- documentation/poky-ref-manual/ref-structure.xml | 5 +++-- documentation/poky-ref-manual/resources.xml | 7 +++++-- documentation/poky.ent | 1 - 8 files changed, 34 insertions(+), 21 deletions(-) diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index 87da378161..fb610b329f 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml @@ -169,9 +169,11 @@ BitBake: The tool used by the OpenEmbedded build system to process project metadata. - - BitBake User Manual: A comprehensive guide to the BitBake tool. - + BitBake User Manual: + A comprehensive guide to the BitBake tool. + If you want information on BitBake, see the user manual inculded in the + bitbake/doc/manual directory of the + Source Directory. QEMU: An open-source machine emulator and virtualizer. diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 62fc50e6ae..a55f08a4fb 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -192,8 +192,9 @@ You might want to reference this information. Build the image: The OpenEmbedded build system uses the BitBake tool to build images based on the type of image you want to create. - You can find more information on BitBake - here. + You can find more information about BitBake in the user manual, which is found in the + bitbake/doc/manual directory of the + Source Directory. The build process supports several types of images to satisfy different needs. See the "Images" chapter @@ -495,8 +496,9 @@ Build the image: The OpenEmbedded build system uses the BitBake tool to build images based on the type of image you want to create. - You can find more information on BitBake - here. + You can find more information on BitBake in the user manual, which is found in the + bitbake/doc/manual directory of the + Source Directory. The build process supports several types of images to satisfy different needs. See the "Images" chapter in the Yocto Project Reference Manual for information on supported images. diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 96d6829d3e..9a78d40bb2 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -211,10 +211,12 @@ "Using .bbappend Files" and "Changing recipes-kernel" sections. - BitBake: The task executor and scheduler used by + BitBake: + The task executor and scheduler used by the OpenEmbedded build system to build images. - For more information on BitBake, see the - BitBake documentation. + For more information on BitBake, see the BitBake documentation + in the bitbake/doc/manual directory of the + Source Directory. Build Directory: This term refers to the area used by the OpenEmbedded build system for builds. diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 0d211807bc..3209cb29b7 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -32,7 +32,7 @@ You can use the OpenEmbedded build system, which uses - BitBake, to develop complete Linux + BitBake to develop complete Linux images and associated user-space applications for architectures based on ARM, MIPS, PowerPC, x86 and x86-64. While the Yocto Project does not provide a strict testing framework, @@ -277,8 +277,9 @@ a centralized tarball download directory through the DL_DIR variable. Build the image using the bitbake command. - If you want information on BitBake, see the user manual at - . + If you want information on BitBake, see the user manual inculded in the + bitbake/doc/manual directory of the + Source Directory. Run the image either on the actual hardware or using the QEMU emulator. diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml index f230b54ba5..330d72ef91 100644 --- a/documentation/poky-ref-manual/ref-bitbake.xml +++ b/documentation/poky-ref-manual/ref-bitbake.xml @@ -185,8 +185,9 @@ Dependencies are defined through several variables. - You can find information about variables BitBake uses in the - BitBake manual. + You can find information about variables BitBake uses in the BitBake documentation, + which is found in the bitbake/doc/manual directory within the + Source Directory. At a basic level, it is sufficient to know that BitBake uses the DEPENDS and RDEPENDS variables when @@ -393,7 +394,9 @@ Options: Fetchers are usually triggered by entries in SRC_URI. You can find information about the options and formats of entries for specific - fetchers in the BitBake manual. + fetchers in the BitBake manual located in the + bitbake/doc/manual directory of the + Source Directory. diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index 2db58ddaef..fcdf7b1c6c 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml @@ -46,8 +46,9 @@ - For more information on BitBake, see the BitBake on-line manual at - . + For more information on BitBake, see the BitBake documentation + inculded in the bitbake/doc/manual directory of the + Source Directory. diff --git a/documentation/poky-ref-manual/resources.xml b/documentation/poky-ref-manual/resources.xml index b314d9c948..8c47b18ec7 100644 --- a/documentation/poky-ref-manual/resources.xml +++ b/documentation/poky-ref-manual/resources.xml @@ -83,8 +83,11 @@ Poky derives from and contributes back to the OpenEmbedded project. BitBake: The tool used to process metadata. - - BitBake User Manual: A comprehensive guide to the BitBake tool. + BitBake User Manual: + A comprehensive guide to the BitBake tool. + You can find the BitBake User Manual in the bitbake/doc/manual + directory, which is found in the + Source Directory. QEMU: An open source machine emulator and virtualizer. diff --git a/documentation/poky.ent b/documentation/poky.ent index c5f61490dc..342865acfd 100644 --- a/documentation/poky.ent +++ b/documentation/poky.ent @@ -17,7 +17,6 @@ -