aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
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 /documentation
parent3fa4a6a146666d6817de1076aa0a92198167fb88 (diff)
downloadopenembedded-core-contrib-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>
Diffstat (limited to 'documentation')
-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 @@
BitBake</ulink>:</emphasis> The tool used by the OpenEmbedded build system
to process project metadata.</para></listitem>
<listitem><para><emphasis>
- <ulink url='&BITBAKE_DOCS_URL;'>
- BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool.
- </para></listitem>
+ BitBake User Manual:</emphasis>
+ A comprehensive guide to the BitBake tool.
+ If you want information on BitBake, see the user manual inculded in the
+ <filename>bitbake/doc/manual</filename> directory of the
+ <link linkend='source-directory'>Source Directory</link>.</para></listitem>
<listitem><para><emphasis>
<ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>:
</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 @@
You might want to reference this information.</para></listitem>
<listitem><para><emphasis>Build the image</emphasis>: 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
- <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para>
+ You can find more information about BitBake in the user manual, which is found in the
+ <filename>bitbake/doc/manual</filename> directory of the
+ <link linkend='source-directory'>Source Directory</link>.</para>
<para>The build process supports several types of images to satisfy different needs.
See the
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter
@@ -495,8 +496,9 @@
<listitem><para><emphasis>Build the image</emphasis>: 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
- <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para>
+ You can find more information on BitBake in the user manual, which is found in the
+ <filename>bitbake/doc/manual</filename> directory of the
+ <link linkend='source-directory'>Source Directory</link>.</para>
<para>The build process supports several types of images to satisfy different needs.
See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in
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 @@
"<link linkend='using-bbappend-files'>Using .bbappend Files</link>" and
"<link linkend='changing-recipes-kernel'>Changing <filename>recipes-kernel</filename></link>"
sections.</para></listitem>
- <listitem><para><emphasis>BitBake:</emphasis> The task executor and scheduler used by
+ <listitem><para id='bitbake-term'><emphasis>BitBake:</emphasis>
+ The task executor and scheduler used by
the OpenEmbedded build system to build images.
- For more information on BitBake, see the <ulink url='&BITBAKE_DOCS_URL;'>
- BitBake documentation</ulink>.</para></listitem>
+ For more information on BitBake, see the BitBake documentation
+ in the <filename>bitbake/doc/manual</filename> directory of the
+ <link linkend='source-directory'>Source Directory</link>.</para></listitem>
<listitem>
<para id='build-directory'><emphasis>Build Directory:</emphasis>
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 @@
<para>
You can use the OpenEmbedded build system, which uses
- <ulink url='&BITBAKE_DOCS_URL;'>BitBake</ulink>, 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
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem>
<listitem><para>Build the image using the <filename>bitbake</filename> command.
- If you want information on BitBake, see the user manual at
- <ulink url='&OE_DOCS_URL;/bitbake/html'></ulink>.</para></listitem>
+ If you want information on BitBake, see the user manual inculded in the
+ <filename>bitbake/doc/manual</filename> directory of the
+ <link linkend='source-directory'>Source Directory</link>.</para></listitem>
<listitem><para>Run the image either on the actual hardware or using the QEMU
emulator.</para></listitem>
</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 @@
<para>
Dependencies are defined through several variables.
- You can find information about variables BitBake uses in the
- <ulink url='&BITBAKE_DOCS_URL;'>BitBake manual</ulink>.
+ You can find information about variables BitBake uses in the BitBake documentation,
+ which is found in the <filename>bitbake/doc/manual</filename> directory within the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
At a basic level, it is sufficient to know that BitBake uses the
<filename><link linkend='var-DEPENDS'>DEPENDS</link></filename> and
<filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variables when
@@ -393,7 +394,9 @@ Options:
Fetchers are usually triggered by entries in
<filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>.
You can find information about the options and formats of entries for specific
- fetchers in the <ulink url='&BITBAKE_DOCS_URL;'>BitBake manual</ulink>.
+ fetchers in the BitBake manual located in the
+ <filename>bitbake/doc/manual</filename> directory of the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</para>
<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 @@
</para>
<para>
- For more information on BitBake, see the BitBake on-line manual at
- <ulink url="http://docs.openembedded.org/bitbake/html/"/>.
+ For more information on BitBake, see the BitBake documentation
+ inculded in the <filename>bitbake/doc/manual</filename> directory of the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</para>
</section>
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.</para></listitem>
<listitem><para><emphasis><ulink url='http://developer.berlios.de/projects/bitbake/'>
BitBake</ulink>:</emphasis> The tool used to process metadata.</para></listitem>
- <listitem><para><emphasis><ulink url='&BITBAKE_DOCS_URL;'>
- BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool.
+ <listitem><para><emphasis>BitBake User Manual:</emphasis>
+ A comprehensive guide to the BitBake tool.
+ You can find the BitBake User Manual in the <filename>bitbake/doc/manual</filename>
+ directory, which is found in the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</para></listitem>
<listitem><para><emphasis><ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>:
</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 @@
<!ENTITY OE_DOCS_URL "http://docs.openembedded.org">
<!ENTITY OH_HOME_URL "http://o-hand.com">
<!ENTITY BITBAKE_HOME_URL "http://developer.berlios.de/projects/bitbake/">
-<!ENTITY BITBAKE_DOCS_URL "http://docs.openembedded.org/bitbake/html/">
<!ENTITY ECLIPSE_MAIN_URL "http://www.eclipse.org/downloads">
<!ENTITY ECLIPSE_DL_URL "http://download.eclipse.org">
<!ENTITY ECLIPSE_DL_PLUGIN_URL "&YOCTO_DL_URL;/releases/eclipse-plugin/&DISTRO;">