summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-09-04 12:05:21 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-09-14 09:50:45 +0100
commit64b9137b43207c0505c4d8c26e654152b5a699da (patch)
tree3620f581aa55f119e3e2d2c48592cd8e9d307b73
parent3fa4a6a146666d6817de1076aa0a92198167fb88 (diff)
downloadpoky-64b9137b43207c0505c4d8c26e654152b5a699da.tar.gz
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 <rpjday@crashcourse.ca> (From yocto-docs rev: 12f77236b602e9ec43e845c8cec060ad342af19c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-intro.xml8
-rw-r--r--documentation/dev-manual/dev-manual-model.xml10
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml8
-rw-r--r--documentation/dev-manual/dev-manual-start.xml7
-rw-r--r--documentation/poky-ref-manual/ref-bitbake.xml9
-rw-r--r--documentation/poky-ref-manual/ref-structure.xml5
-rw-r--r--documentation/poky-ref-manual/resources.xml7
-rw-r--r--documentation/poky.ent1
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 @@
169 BitBake</ulink>:</emphasis> The tool used by the OpenEmbedded build system 169 BitBake</ulink>:</emphasis> The tool used by the OpenEmbedded build system
170 to process project metadata.</para></listitem> 170 to process project metadata.</para></listitem>
171 <listitem><para><emphasis> 171 <listitem><para><emphasis>
172 <ulink url='&BITBAKE_DOCS_URL;'> 172 BitBake User Manual:</emphasis>
173 BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool. 173 A comprehensive guide to the BitBake tool.
174 </para></listitem> 174 If you want information on BitBake, see the user manual inculded in the
175 <filename>bitbake/doc/manual</filename> directory of the
176 <link linkend='source-directory'>Source Directory</link>.</para></listitem>
175 <listitem><para><emphasis> 177 <listitem><para><emphasis>
176 <ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>: 178 <ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>:
177 </emphasis> An open-source machine emulator and virtualizer.</para></listitem> 179 </emphasis> An open-source machine emulator and virtualizer.</para></listitem>
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 @@
192 You might want to reference this information.</para></listitem> 192 You might want to reference this information.</para></listitem>
193 <listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded build system 193 <listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded build system
194 uses the BitBake tool to build images based on the type of image you want to create. 194 uses the BitBake tool to build images based on the type of image you want to create.
195 You can find more information on BitBake 195 You can find more information about BitBake in the user manual, which is found in the
196 <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para> 196 <filename>bitbake/doc/manual</filename> directory of the
197 <link linkend='source-directory'>Source Directory</link>.</para>
197 <para>The build process supports several types of images to satisfy different needs. 198 <para>The build process supports several types of images to satisfy different needs.
198 See the 199 See the
199 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter 200 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter
@@ -495,8 +496,9 @@
495 <listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded 496 <listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded
496 build system uses the BitBake 497 build system uses the BitBake
497 tool to build images based on the type of image you want to create. 498 tool to build images based on the type of image you want to create.
498 You can find more information on BitBake 499 You can find more information on BitBake in the user manual, which is found in the
499 <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para> 500 <filename>bitbake/doc/manual</filename> directory of the
501 <link linkend='source-directory'>Source Directory</link>.</para>
500 <para>The build process supports several types of images to satisfy different needs. 502 <para>The build process supports several types of images to satisfy different needs.
501 See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in 503 See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in
502 the Yocto Project Reference Manual for information on supported images.</para></listitem> 504 the Yocto Project Reference Manual for information on supported images.</para></listitem>
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 @@
211 "<link linkend='using-bbappend-files'>Using .bbappend Files</link>" and 211 "<link linkend='using-bbappend-files'>Using .bbappend Files</link>" and
212 "<link linkend='changing-recipes-kernel'>Changing <filename>recipes-kernel</filename></link>" 212 "<link linkend='changing-recipes-kernel'>Changing <filename>recipes-kernel</filename></link>"
213 sections.</para></listitem> 213 sections.</para></listitem>
214 <listitem><para><emphasis>BitBake:</emphasis> The task executor and scheduler used by 214 <listitem><para id='bitbake-term'><emphasis>BitBake:</emphasis>
215 The task executor and scheduler used by
215 the OpenEmbedded build system to build images. 216 the OpenEmbedded build system to build images.
216 For more information on BitBake, see the <ulink url='&BITBAKE_DOCS_URL;'> 217 For more information on BitBake, see the BitBake documentation
217 BitBake documentation</ulink>.</para></listitem> 218 in the <filename>bitbake/doc/manual</filename> directory of the
219 <link linkend='source-directory'>Source Directory</link>.</para></listitem>
218 <listitem> 220 <listitem>
219 <para id='build-directory'><emphasis>Build Directory:</emphasis> 221 <para id='build-directory'><emphasis>Build Directory:</emphasis>
220 This term refers to the area used by the OpenEmbedded build system for builds. 222 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 @@
32 32
33 <para> 33 <para>
34 You can use the OpenEmbedded build system, which uses 34 You can use the OpenEmbedded build system, which uses
35 <ulink url='&BITBAKE_DOCS_URL;'>BitBake</ulink>, to develop complete Linux 35 BitBake to develop complete Linux
36 images and associated user-space applications for architectures based on ARM, MIPS, PowerPC, 36 images and associated user-space applications for architectures based on ARM, MIPS, PowerPC,
37 x86 and x86-64. 37 x86 and x86-64.
38 While the Yocto Project does not provide a strict testing framework, 38 While the Yocto Project does not provide a strict testing framework,
@@ -277,8 +277,9 @@
277 a centralized tarball download directory through the 277 a centralized tarball download directory through the
278 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> 278 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem>
279 <listitem><para>Build the image using the <filename>bitbake</filename> command. 279 <listitem><para>Build the image using the <filename>bitbake</filename> command.
280 If you want information on BitBake, see the user manual at 280 If you want information on BitBake, see the user manual inculded in the
281 <ulink url='&OE_DOCS_URL;/bitbake/html'></ulink>.</para></listitem> 281 <filename>bitbake/doc/manual</filename> directory of the
282 <link linkend='source-directory'>Source Directory</link>.</para></listitem>
282 <listitem><para>Run the image either on the actual hardware or using the QEMU 283 <listitem><para>Run the image either on the actual hardware or using the QEMU
283 emulator.</para></listitem> 284 emulator.</para></listitem>
284 </orderedlist> 285 </orderedlist>
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 @@
185 185
186 <para> 186 <para>
187 Dependencies are defined through several variables. 187 Dependencies are defined through several variables.
188 You can find information about variables BitBake uses in the 188 You can find information about variables BitBake uses in the BitBake documentation,
189 <ulink url='&BITBAKE_DOCS_URL;'>BitBake manual</ulink>. 189 which is found in the <filename>bitbake/doc/manual</filename> directory within the
190 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
190 At a basic level, it is sufficient to know that BitBake uses the 191 At a basic level, it is sufficient to know that BitBake uses the
191 <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename> and 192 <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename> and
192 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variables when 193 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variables when
@@ -393,7 +394,9 @@ Options:
393 Fetchers are usually triggered by entries in 394 Fetchers are usually triggered by entries in
394 <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>. 395 <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>.
395 You can find information about the options and formats of entries for specific 396 You can find information about the options and formats of entries for specific
396 fetchers in the <ulink url='&BITBAKE_DOCS_URL;'>BitBake manual</ulink>. 397 fetchers in the BitBake manual located in the
398 <filename>bitbake/doc/manual</filename> directory of the
399 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
397 </para> 400 </para>
398 401
399 <para> 402 <para>
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 @@
46 </para> 46 </para>
47 47
48 <para> 48 <para>
49 For more information on BitBake, see the BitBake on-line manual at 49 For more information on BitBake, see the BitBake documentation
50 <ulink url="http://docs.openembedded.org/bitbake/html/"/>. 50 inculded in the <filename>bitbake/doc/manual</filename> directory of the
51 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
51 </para> 52 </para>
52 </section> 53 </section>
53 54
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 @@
83 Poky derives from and contributes back to the OpenEmbedded project.</para></listitem> 83 Poky derives from and contributes back to the OpenEmbedded project.</para></listitem>
84 <listitem><para><emphasis><ulink url='http://developer.berlios.de/projects/bitbake/'> 84 <listitem><para><emphasis><ulink url='http://developer.berlios.de/projects/bitbake/'>
85 BitBake</ulink>:</emphasis> The tool used to process metadata.</para></listitem> 85 BitBake</ulink>:</emphasis> The tool used to process metadata.</para></listitem>
86 <listitem><para><emphasis><ulink url='&BITBAKE_DOCS_URL;'> 86 <listitem><para><emphasis>BitBake User Manual:</emphasis>
87 BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool. 87 A comprehensive guide to the BitBake tool.
88 You can find the BitBake User Manual in the <filename>bitbake/doc/manual</filename>
89 directory, which is found in the
90 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
88 </para></listitem> 91 </para></listitem>
89 <listitem><para><emphasis><ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>: 92 <listitem><para><emphasis><ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>:
90 </emphasis> An open source machine emulator and virtualizer.</para></listitem> 93 </emphasis> An open source machine emulator and virtualizer.</para></listitem>
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 @@
17<!ENTITY OE_DOCS_URL "http://docs.openembedded.org"> 17<!ENTITY OE_DOCS_URL "http://docs.openembedded.org">
18<!ENTITY OH_HOME_URL "http://o-hand.com"> 18<!ENTITY OH_HOME_URL "http://o-hand.com">
19<!ENTITY BITBAKE_HOME_URL "http://developer.berlios.de/projects/bitbake/"> 19<!ENTITY BITBAKE_HOME_URL "http://developer.berlios.de/projects/bitbake/">
20<!ENTITY BITBAKE_DOCS_URL "http://docs.openembedded.org/bitbake/html/">
21<!ENTITY ECLIPSE_MAIN_URL "http://www.eclipse.org/downloads"> 20<!ENTITY ECLIPSE_MAIN_URL "http://www.eclipse.org/downloads">
22<!ENTITY ECLIPSE_DL_URL "http://download.eclipse.org"> 21<!ENTITY ECLIPSE_DL_URL "http://download.eclipse.org">
23<!ENTITY ECLIPSE_DL_PLUGIN_URL "&YOCTO_DL_URL;/releases/eclipse-plugin/&DISTRO;"> 22<!ENTITY ECLIPSE_DL_PLUGIN_URL "&YOCTO_DL_URL;/releases/eclipse-plugin/&DISTRO;">