[PATCH] dev-manual: chs 1,2; rewording, cleanup


Robert P. J. Day
 

Also removal of way too much unnecessary capitalization.

Signed-off-by: Robert P. J. Day <rpjday@...>

---

diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml
index 3a34094b8..5e231c6ac 100644
--- a/documentation/dev-manual/dev-manual-intro.xml
+++ b/documentation/dev-manual/dev-manual-intro.xml
@@ -22,22 +22,22 @@
This manual provides the following:
<itemizedlist>
<listitem><para>
- Procedures that help you get going with the Yocto Project.
- For example, procedures that show you how to set up
+ Procedures that help you get going with the Yocto Project;
+ for example, procedures that show you how to set up
a build host and work with the Yocto Project
source repositories.
</para></listitem>
<listitem><para>
Procedures that show you how to submit changes to the
- Yocto Project.
- Changes can be improvements, new features, or bug
+ Yocto Project;
+ such changes can be improvements, new features, or bug
fixes.
</para></listitem>
<listitem><para>
Procedures related to "everyday" tasks you perform while
developing images and applications using the Yocto
- Project.
- For example, procedures to create a layer, customize an
+ Project;
+ for example, procedures to create a layer, customize an
image, write a new recipe, and so forth.
</para></listitem>
</itemizedlist>
@@ -47,26 +47,26 @@
This manual does not provide the following:
<itemizedlist>
<listitem><para>
- Redundant Step-by-step Instructions:
- For example, the
+ Redundant step-by-step instructions:
+ The
<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink>
- manual contains detailed instructions on how to install an
+ manual already contains detailed instructions on how to install an
SDK, which is used to develop applications for target
hardware.
</para></listitem>
<listitem><para>
- Reference or Conceptual Material:
+ Reference or conceptual material:
This type of material resides in an appropriate reference
manual.
For example, system variables are documented in the
<ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>.
</para></listitem>
<listitem><para>
- Detailed Public Information Not Specific to the
+ Detailed public information not specific to the
Yocto Project:
- For example, exhaustive information on how to use the
+ As an example, exhaustive information on how to use the
Source Control Manager Git is better covered with Internet
- searches and official Git Documentation than through the
+ searches and official Git documentation than through the
Yocto Project documentation.
</para></listitem>
</itemizedlist>
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 59ffa49bb..340cefd37 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -24,8 +24,8 @@
Project in a team development environment, or how to scale it for a
large team of developers.
You can adapt the Yocto Project to many different use cases and
- scenarios.
- However, this flexibility could cause difficulties if you are trying
+ scenarios;
+ however, this flexibility could cause difficulties if you are trying
to create a working setup that scales across a large team.
</para>

@@ -117,7 +117,7 @@
Of the SCMs BitBake supports, the Yocto Project team strongly
recommends using
<ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink>.
- Git is a distributed system that is easy to backup,
+ Git is a distributed version control system that is easy to backup,
allows you to work remotely, and then connects back to the
infrastructure.
<note>
@@ -168,8 +168,8 @@
<itemizedlist>
<listitem><para>
Use a pre-built toolchain that contains the software
- stack itself.
- Then, develop the application code on top of the
+ stack itself,
+ and develop the application code on top of the
stack.
This method works well for small numbers of relatively
isolated applications.
@@ -302,7 +302,7 @@
<para>As with any development environment, it is important
to document the policy used as well as any main project
guidelines so they are understood by everyone.
- It is also a good idea to have well structured
+ It is also a good idea to have well-structured
commit messages, which are usually a part of a project's
guidelines.
Good commit messages are essential when looking back in time and

--

========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca

Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================

Join yocto@lists.yoctoproject.org to automatically receive all group messages.