summaryrefslogtreecommitdiffstats
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)
downloadpoky-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 @@
78 <listitem><para>Step-by-step instructions if those instructions exist in other Yocto 78 <listitem><para>Step-by-step instructions if those instructions exist in other Yocto
79 Project documentation. 79 Project documentation.
80 For example, the Yocto Project Application Developer's Guide contains detailed 80 For example, the Yocto Project Application Developer's Guide contains detailed
81 instruction on how to run the 81 instructions on how to run the
82 <ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>, 82 <ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>,
83 which is used to set up a cross-development environment.</para></listitem> 83 which is used to set up a cross-development environment.</para></listitem>
84 <listitem><para>Reference material. 84 <listitem><para>Reference material.
@@ -96,8 +96,9 @@
96 <title>Other Information</title> 96 <title>Other Information</title>
97 97
98 <para> 98 <para>
99 Because this manual presents overview information for many different topics, you will 99 Because this manual presents overview information for many different
100 need to supplement it with other information. 100 topics, supplemental information is recommended for full
101 comprehension.
101 The following list presents other sources of information you might find helpful: 102 The following list presents other sources of information you might find helpful:
102 <itemizedlist> 103 <itemizedlist>
103 <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>: 104 <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:
@@ -105,7 +106,7 @@
105 as well as links to software and documentation.</para></listitem> 106 as well as links to software and documentation.</para></listitem>
106 <listitem><para><emphasis> 107 <listitem><para><emphasis>
107 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started 108 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started
108 with the Yocto Project quickly and start building an image.</para></listitem> 109 with the Yocto Project and quickly begin building an image.</para></listitem>
109 <listitem><para><emphasis> 110 <listitem><para><emphasis>
110 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference 111 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference
111 guide to the OpenEmbedded build system known as "Poky." 112 guide to the OpenEmbedded build system known as "Poky."
@@ -169,7 +170,7 @@
169 OpenEmbedded build system (Poky). 170 OpenEmbedded build system (Poky).
170 </para></listitem> 171 </para></listitem>
171 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink> 172 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink>
172 for a mailing list to receive official Yocto Project announcements for developments and 173 for a mailing list to receive official Yocto Project announcements
173 as well as Yocto Project milestones.</para></listitem> 174 as well as Yocto Project milestones.</para></listitem>
174 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink> for a 175 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink> for a
175 listing of all public mailing lists on <filename>lists.yoctoproject.org</filename>. 176 listing of all public mailing lists on <filename>lists.yoctoproject.org</filename>.
@@ -182,7 +183,7 @@
182 <listitem><para><emphasis> 183 <listitem><para><emphasis>
183 <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis> 184 <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
184 The build system used by the Yocto Project. 185 The build system used by the Yocto Project.
185 This project is the upstream, generic, embedded distribution from which the Yocto 186 This project is the upstream, generic, embedded distribution that the Yocto
186 Project derives its build system (Poky) from and to which it contributes.</para></listitem> 187 Project derives its build system (Poky) from and to which it contributes.</para></listitem>
187 <listitem><para><emphasis> 188 <listitem><para><emphasis>
188 <ulink url='http://developer.berlios.de/projects/bitbake/'> 189 <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 @@
23 23
24 <para> 24 <para>
25 The Yocto Project is an open-source collaboration project focused on embedded Linux development. 25 The Yocto Project is an open-source collaboration project focused on embedded Linux development.
26 The project currently provides a build system, which is 26 The project currently provides a build system that is
27 referred to as the OpenEmbedded build system in the Yocto Project documentation. 27 referred to as the OpenEmbedded build system in the Yocto Project documentation.
28 The Yocto Project provides various ancillary tools suitable for the embedded developer 28 The Yocto Project provides various ancillary tools for the embedded developer
29 and also features the Sato reference User Interface, which is optimized for 29 and also features the Sato reference User Interface, which is optimized for
30 stylus driven, low-resolution screens. 30 stylus driven, low-resolution screens.
31 </para> 31 </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 @@
23 <note> 23 <note>
24 BitBake strives to be a generic "task" executor that is capable of handling complex dependency relationships. 24 BitBake strives to be a generic "task" executor that is capable of handling complex dependency relationships.
25 As such, it has no real knowledge of what the tasks being executed actually do. 25 As such, it has no real knowledge of what the tasks being executed actually do.
26 BitBake just considers a list of tasks with dependencies and handles metadata 26 BitBake just considers a list of tasks with dependencies and handles
27 that consists of variables in a certain format that get passed to the tasks. 27 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
28 consisting of variables in a certain format that get passed to the tasks.
28 </note> 29 </note>
29 30
30 <section id='ref-bitbake-parsing'> 31 <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 @@
38 The <filename>build_dir</filename> is optional and specifies the directory the 38 The <filename>build_dir</filename> is optional and specifies the directory the
39 OpenEmbedded build system uses for the build - 39 OpenEmbedded build system uses for the build -
40 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 40 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
41 If you do not specify a Build Directory, it defaults to <filename>build</filename> 41 If you do not specify a Build Directory, it defaults to a directory
42 in your current working directory. 42 named <filename>build</filename> in your current working directory.
43 A common practice is to use a different Build Directory for different targets. 43 A common practice is to use a different Build Directory for different targets.
44 For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename> 44 For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename>
45 target, and <filename>~/build/arm</filename> for a <filename>qemuarm</filename> target. 45 target, and <filename>~/build/arm</filename> for a <filename>qemuarm</filename> target.