aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-04-22 14:23:29 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-05-22 17:23:38 +0100
commit514176c231f71886a1a4be48a7a7a4fb43433e74 (patch)
treee86088707d790323f89377b7a6e105c62c8c8208 /documentation
parent818ec77cd3d0293ec5ef659e18a7e22d49f81737 (diff)
downloadopenembedded-core-contrib-514176c231f71886a1a4be48a7a7a4fb43433e74.tar.gz
dev-manual, ref-manual: Minor edits suggested by Bill Traynor
Applied some re-wordings as suggested by Bill Traynor. Reported-by: William M.A. Traynor <wmat@alphatroop.com> (From yocto-docs rev: 2510d9795720afc0309a10b18605e5af4a83769b) 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.xml13
-rw-r--r--documentation/dev-manual/dev-manual-start.xml4
-rw-r--r--documentation/ref-manual/ref-bitbake.xml5
-rw-r--r--documentation/ref-manual/usingpoky.xml4
4 files changed, 14 insertions, 12 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml
index b0d6386fea..ed1ab07fb1 100644
--- a/documentation/dev-manual/dev-manual-intro.xml
+++ b/documentation/dev-manual/dev-manual-intro.xml
@@ -78,7 +78,7 @@
<listitem><para>Step-by-step instructions if those instructions exist in other Yocto
Project documentation.
For example, the Yocto Project Application Developer's Guide contains detailed
- instruction on how to run the
+ instructions on how to run the
<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>,
which is used to set up a cross-development environment.</para></listitem>
<listitem><para>Reference material.
@@ -96,8 +96,9 @@
<title>Other Information</title>
<para>
- Because this manual presents overview information for many different topics, you will
- need to supplement it with other information.
+ Because this manual presents overview information for many different
+ topics, supplemental information is recommended for full
+ comprehension.
The following list presents other sources of information you might find helpful:
<itemizedlist>
<listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:
@@ -105,7 +106,7 @@
as well as links to software and documentation.</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started
- with the Yocto Project quickly and start building an image.</para></listitem>
+ with the Yocto Project and quickly begin building an image.</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference
guide to the OpenEmbedded build system known as "Poky."
@@ -169,7 +170,7 @@
OpenEmbedded build system (Poky).
</para></listitem>
<listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink>
- for a mailing list to receive official Yocto Project announcements for developments and
+ for a mailing list to receive official Yocto Project announcements
as well as Yocto Project milestones.</para></listitem>
<listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink> for a
listing of all public mailing lists on <filename>lists.yoctoproject.org</filename>.
@@ -182,7 +183,7 @@
<listitem><para><emphasis>
<ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
The build system used by the Yocto Project.
- This project is the upstream, generic, embedded distribution from which the Yocto
+ This project is the upstream, generic, embedded distribution that the Yocto
Project derives its build system (Poky) from and to which it contributes.</para></listitem>
<listitem><para><emphasis>
<ulink url='http://developer.berlios.de/projects/bitbake/'>
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 719d0f3919..02f6bd0452 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -23,9 +23,9 @@
<para>
The Yocto Project is an open-source collaboration project focused on embedded Linux development.
- The project currently provides a build system, which is
+ The project currently provides a build system that is
referred to as the OpenEmbedded build system in the Yocto Project documentation.
- The Yocto Project provides various ancillary tools suitable for the embedded developer
+ The Yocto Project provides various ancillary tools for the embedded developer
and also features the Sato reference User Interface, which is optimized for
stylus driven, low-resolution screens.
</para>
diff --git a/documentation/ref-manual/ref-bitbake.xml b/documentation/ref-manual/ref-bitbake.xml
index cc4c943506..717c58bd71 100644
--- a/documentation/ref-manual/ref-bitbake.xml
+++ b/documentation/ref-manual/ref-bitbake.xml
@@ -23,8 +23,9 @@
<note>
BitBake strives to be a generic "task" executor that is capable of handling complex dependency relationships.
As such, it has no real knowledge of what the tasks being executed actually do.
- BitBake just considers a list of tasks with dependencies and handles metadata
- that consists of variables in a certain format that get passed to the tasks.
+ BitBake just considers a list of tasks with dependencies and handles
+ <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
+ consisting of variables in a certain format that get passed to the tasks.
</note>
<section id='ref-bitbake-parsing'>
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index d27d6f7a5e..9a98b4560a 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -38,8 +38,8 @@
The <filename>build_dir</filename> is optional and specifies the directory the
OpenEmbedded build system uses for the build -
the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
- If you do not specify a Build Directory, it defaults to <filename>build</filename>
- in your current working directory.
+ If you do not specify a Build Directory, it defaults to a directory
+ named <filename>build</filename> in your current working directory.
A common practice is to use a different Build Directory for different targets.
For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename>
target, and <filename>~/build/arm</filename> for a <filename>qemuarm</filename> target.