summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-04-10 15:46:02 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-04-12 12:35:47 +0100
commit853c5613acd65ef76996931ca39e55cab11594e1 (patch)
tree736de7d73e747d73ad0b9362d48d4e28c7dfd1d2
parent17c4134ebdbb43b01eced4feddbed6988998a6fa (diff)
downloadpoky-853c5613acd65ef76996931ca39e55cab11594e1.tar.gz
poky-853c5613acd65ef76996931ca39e55cab11594e1.tar.bz2
poky-853c5613acd65ef76996931ca39e55cab11594e1.zip
documentation: Run-through changes for 1.2
Reading through the manual I discovered some inconsistencies with how links were handled. I fixed this in both the QS and one anchor in the FAQ appendix of the YP Reference Manual. (From yocto-docs rev: 32444e839a1541ab2c02fa31cd094605d1a2429a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/poky-ref-manual/faq.xml2
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml37
2 files changed, 17 insertions, 22 deletions
diff --git a/documentation/poky-ref-manual/faq.xml b/documentation/poky-ref-manual/faq.xml
index 249a28d8f4..e0dbb1d84d 100644
--- a/documentation/poky-ref-manual/faq.xml
+++ b/documentation/poky-ref-manual/faq.xml
@@ -493,7 +493,7 @@
<qandaentry>
<question>
<para id='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>
- How does the Yocto Project obtain source code and will it work behind my
+ How does the Yocto Project build system obtain source code and will it work behind my
firewall or proxy server?
</para>
</question>
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index 9ab11a5f1d..96610f4aec 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -294,9 +294,7 @@
Doing so allows you to contribute back to the project.
For information on how to get set up using this method, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto
- Project Release</ulink>" item in
- <ulink url='&YOCTO_DOCS_DEV_URL;'>The Yocto Project
- Development Manual</ulink>.
+ Project Release</ulink>" item in The Yocto Project Development Manual.
</para>
</section>
</section>
@@ -351,9 +349,9 @@
By default, the Yocto Project searches for source code using a pre-determined order
through a set of locations.
If you encounter problems with the Yocto Project finding and downloading source code, see
- the FAQ entry "How does Poky obtain source code and will it work behind my
+ the FAQ entry "How does the Yocto Project build system obtain source code and will it work behind my
firewall or proxy server?" in
- <ulink url='&YOCTO_DOCS_REF_URL;'>
+ <ulink url='&YOCTO_DOCS_REF_URL;#faq'>
The Yocto Project Reference Manual</ulink>.
</para></note>
@@ -361,14 +359,14 @@
<literallayout class='monospaced'>
$ wget &YOCTO_POKY_DL_URL;
$ tar xjf &YOCTO_POKY;.tar.bz2
- $ source &OE_INIT_PATH; edison-6.0-build
+ $ source &OE_INIT_PATH; &YOCTO_POKY;-build
</literallayout>
</para>
<tip><para>
To help conserve disk space during builds, you can add the following statement
to your project's configuration file, which for this example
- is <filename>edison-6.0-build/conf/local.conf</filename>.
+ is <filename>&YOCTO_POKY;-build/conf/local.conf</filename>.
Adding this statement deletes the work directory used for building a package
once the package is built.
<literallayout class='monospaced'>
@@ -384,13 +382,13 @@
<ulink url='&YOCTO_HOME_URL;/download'>Yocto Project website</ulink>
Downloads page to retrieve the tarball.</para></listitem>
<listitem><para>The second command extracts the files from the tarball and places
- them into a directory named <filename>poky-edison-6.0</filename> in the current
+ them into a directory named <filename>&YOCTO_POKY;</filename> in the current
directory.</para></listitem>
<listitem><para>The third command runs the Yocto Project environment setup script.
Running this script defines Yocto Project build environment settings needed to
complete the build.
The script also creates the Yocto Project
- build directory, which is <filename>edison-6.0-build</filename> in this case.
+ build directory, which is <filename>&YOCTO_POKY;-build</filename> in this case.
After the script runs, your current working directory is set
to the build directory.
Later, when the build completes, the build directory contains all the files
@@ -430,9 +428,8 @@
You can control this configuration by using the
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable.
For additional package manager selection information, see
- "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>" in
- <ulink url='&YOCTO_DOCS_REF_URL;'>
- The Yocto Project Reference Manual</ulink>.
+ "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>"
+ in The Yocto Project Reference Manual.
</para>
<para>
@@ -441,15 +438,15 @@
For information on the <filename>-k</filename> option use the
<filename>bitbake --help</filename> command or see the
"<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" section in
- <ulink url='&YOCTO_DOCS_REF_URL;'>The Yocto Project Reference Manual</ulink>.
+ The Yocto Project Reference Manual.
<literallayout class='monospaced'>
$ bitbake -k core-image-sato
</literallayout>
<note><para>
BitBake requires Python 2.6 or 2.7. For more information on this requirement,
- see the FAQ appendix in
- <ulink url='&YOCTO_DOCS_REF_URL;'>
- The Yocto Project Reference Manual</ulink>.
+ see the
+ <ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> in The Yocto Project Reference
+ Manual.
</para></note>
The final command runs the image:
<literallayout class='monospaced'>
@@ -550,9 +547,8 @@
<para>
For more information on how to install tarballs, see the
"<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" and
- "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Yocto Project Build Tree</ulink>" sections in
- <ulink url='&YOCTO_DOCS_ADT_URL;'>The Yocto Project
- Application Development Toolkit (ADT) User's Guide</ulink>.
+ "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Yocto Project Build Tree</ulink>" sections in The Yocto Project Application Development Toolkit (ADT)
+ User's Guide.
</para>
</section>
@@ -583,8 +579,7 @@
<para>
You can learn more about downloading a Yocto Project kernel in the
"<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink>" section of
- <ulink url='&YOCTO_DOCS_DEV_URL;'>The
- Yocto Project Development Manual</ulink>.
+ The Yocto Project Development Manual.
</para>
</section>