sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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>
This commit is contained in:
Scott Rifenbark 2012-09-04 12:05:21 -07:00 committed by Richard Purdie
parent 3fa4a6a146
commit 64b9137b43
8 changed files with 34 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/dev-manual/dev-manual-intro.xml
View File

@ -169,9 +169,11 @@
BitBake</ulink>:</emphasis> The tool used by the OpenEmbedded build system BitBake</ulink>:</emphasis> The tool used by the OpenEmbedded build system
to process project metadata.</para></listitem> to process project metadata.</para></listitem>
<listitem><para><emphasis> <listitem><para><emphasis>
<ulink url='&BITBAKE_DOCS_URL;'> BitBake User Manual:</emphasis>
BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool. A comprehensive guide to the BitBake tool.
</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><emphasis> <listitem><para><emphasis>
<ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>: <ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>:
</emphasis> An open-source machine emulator and virtualizer.</para></listitem> </emphasis> An open-source machine emulator and virtualizer.</para></listitem>

10
documentation/dev-manual/dev-manual-model.xml
View File

@ -192,8 +192,9 @@
You might want to reference this information.</para></listitem> You might want to reference this information.</para></listitem>
<listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded build system <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. uses the BitBake tool to build images based on the type of image you want to create.
You can find more information on BitBake You can find more information about BitBake in the user manual, which is found in the
<ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para> <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. <para>The build process supports several types of images to satisfy different needs.
See the See the
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter
@ -495,8 +496,9 @@
<listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded <listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded
build system uses the BitBake build system uses the BitBake
tool to build images based on the type of image you want to create. tool to build images based on the type of image you want to create.
You can find more information on BitBake You can find more information on BitBake in the user manual, which is found in the
<ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para> <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. <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 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> the Yocto Project Reference Manual for information on supported images.</para></listitem>

8
documentation/dev-manual/dev-manual-newbie.xml
View File

@ -211,10 +211,12 @@
"<link linkend='using-bbappend-files'>Using .bbappend Files</link>" and "<link linkend='using-bbappend-files'>Using .bbappend Files</link>" and
"<link linkend='changing-recipes-kernel'>Changing <filename>recipes-kernel</filename></link>" "<link linkend='changing-recipes-kernel'>Changing <filename>recipes-kernel</filename></link>"
sections.</para></listitem> 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. the OpenEmbedded build system to build images.
For more information on BitBake, see the <ulink url='&BITBAKE_DOCS_URL;'> For more information on BitBake, see the BitBake documentation
BitBake documentation</ulink>.</para></listitem> in the <filename>bitbake/doc/manual</filename> directory of the
<link linkend='source-directory'>Source Directory</link>.</para></listitem>
<listitem> <listitem>
<para id='build-directory'><emphasis>Build Directory:</emphasis> <para id='build-directory'><emphasis>Build Directory:</emphasis>
This term refers to the area used by the OpenEmbedded build system for builds. This term refers to the area used by the OpenEmbedded build system for builds.

7
documentation/dev-manual/dev-manual-start.xml
View File

@ -32,7 +32,7 @@
<para> <para>
You can use the OpenEmbedded build system, which uses 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, images and associated user-space applications for architectures based on ARM, MIPS, PowerPC,
x86 and x86-64. x86 and x86-64.
While the Yocto Project does not provide a strict testing framework, While the Yocto Project does not provide a strict testing framework,
@ -277,8 +277,9 @@
a centralized tarball download directory through the a centralized tarball download directory through the
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> <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. <listitem><para>Build the image using the <filename>bitbake</filename> 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
<ulink url='&OE_DOCS_URL;/bitbake/html'></ulink>.</para></listitem> <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 <listitem><para>Run the image either on the actual hardware or using the QEMU
emulator.</para></listitem> emulator.</para></listitem>
</orderedlist> </orderedlist>

9
documentation/poky-ref-manual/ref-bitbake.xml
View File

@ -185,8 +185,9 @@
<para> <para>
Dependencies are defined through several variables. Dependencies are defined through several variables.
You can find information about variables BitBake uses in the You can find information about variables BitBake uses in the BitBake documentation,
<ulink url='&BITBAKE_DOCS_URL;'>BitBake manual</ulink>. 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 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-DEPENDS'>DEPENDS</link></filename> and
<filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variables when <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variables when
@ -393,7 +394,9 @@ Options:
Fetchers are usually triggered by entries in Fetchers are usually triggered by entries in
<filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>. <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>.
You can find information about the options and formats of entries for specific 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>
<para> <para>

5
documentation/poky-ref-manual/ref-structure.xml
View File

@ -46,8 +46,9 @@
</para> </para>
<para> <para>
For more information on BitBake, see the BitBake on-line manual at For more information on BitBake, see the BitBake documentation
<ulink url="http://docs.openembedded.org/bitbake/html/"/>. inculded in the <filename>bitbake/doc/manual</filename> directory of the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</para> </para>
</section> </section>

7
documentation/poky-ref-manual/resources.xml
View File

@ -83,8 +83,11 @@
Poky derives from and contributes back to the OpenEmbedded project.</para></listitem> Poky derives from and contributes back to the OpenEmbedded project.</para></listitem>
<listitem><para><emphasis><ulink url='http://developer.berlios.de/projects/bitbake/'> <listitem><para><emphasis><ulink url='http://developer.berlios.de/projects/bitbake/'>
BitBake</ulink>:</emphasis> The tool used to process metadata.</para></listitem> BitBake</ulink>:</emphasis> The tool used to process metadata.</para></listitem>
<listitem><para><emphasis><ulink url='&BITBAKE_DOCS_URL;'> <listitem><para><emphasis>BitBake User Manual:</emphasis>
BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool. 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> </para></listitem>
<listitem><para><emphasis><ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>: <listitem><para><emphasis><ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>:
</emphasis> An open source machine emulator and virtualizer.</para></listitem> </emphasis> An open source machine emulator and virtualizer.</para></listitem>

1
documentation/poky.ent
View File

@ -17,7 +17,6 @@
<!ENTITY OE_DOCS_URL "http://docs.openembedded.org"> <!ENTITY OE_DOCS_URL "http://docs.openembedded.org">
<!ENTITY OH_HOME_URL "http://o-hand.com"> <!ENTITY OH_HOME_URL "http://o-hand.com">
<!ENTITY BITBAKE_HOME_URL "http://developer.berlios.de/projects/bitbake/"> <!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_MAIN_URL "http://www.eclipse.org/downloads">
<!ENTITY ECLIPSE_DL_URL "http://download.eclipse.org"> <!ENTITY ECLIPSE_DL_URL "http://download.eclipse.org">
<!ENTITY ECLIPSE_DL_PLUGIN_URL "&YOCTO_DL_URL;/releases/eclipse-plugin/&DISTRO;"> <!ENTITY ECLIPSE_DL_PLUGIN_URL "&YOCTO_DL_URL;/releases/eclipse-plugin/&DISTRO;">