From 615e0e83deedf0258466913f39a42eb0848761ca Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Tue, 24 Apr 2018 14:25:46 -0700
Subject: brief-yoctoprojectqs: Added reviewer feedback

Softened the opening paragraph so it was not introducing any special
terms right off the bat.  Renamed the section on the hardware layer
to configuring the build for specific hardware.  Put in a link to
"build host" and used that term throughout.

(From yocto-docs rev: a324cb2f9c499dc8d68d1d87265930c308cbebb7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../brief-yoctoprojectqs/brief-yoctoprojectqs.xml  | 55 ++++++++++++----------
 1 file changed, 29 insertions(+), 26 deletions(-)

(limited to 'documentation/brief-yoctoprojectqs')

diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
index 1241662df6..75dcd34128 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
@@ -33,8 +33,8 @@
             Welcome!
             This short document steps you through the process for a typical
             image build using the Yocto Project.
-            The document also introduces how to add a machine layer and a
-            general layer to your Yocto Project development environment.
+            The document also introduces how to configure a build for specific
+            hardware.
             You will use Yocto Project to build a reference embedded OS
             called Poky.
             <note>
@@ -62,7 +62,9 @@
         <title>Compatible Linux Distribution</title>
 
         <para>
-            Make sure your build system meets the following requirements:
+            Make sure your
+            <ulink url='&YOCTO_DOCS_REF_URL;#hardware-build-system-term'>build host</ulink>
+            meets the following requirements:
             <itemizedlist>
                 <listitem><para>
                     50 Gbytes of free disk space
@@ -98,11 +100,11 @@
     </section>
 
     <section id='brief-build-system-packages'>
-        <title>Build System Packages</title>
+        <title>Build Host Packages</title>
 
         <para>
             You must install essential host packages on your
-            development host.
+            build host.
             The following command installs the host packages based on an
             Ubuntu distribution:
             <note>
@@ -123,7 +125,7 @@
         <para>
             Once you complete the setup instructions for your machine,
             you need to get a copy of the Poky repository on your build
-            system.
+            host.
             Use the following commands to clone the Poky
             repository and then checkout the &DISTRO_REL_TAG; release:
             <literallayout class='monospaced'>
@@ -274,27 +276,26 @@
         </para>
     </section>
 
-    <section id='adding-a-hardware-layer'>
-        <title>Adding a Hardware Layer</title>
+    <section id='customizing-your-build-for-specific-hardware'>
+        <title>Customizing Your Build for Specific Hardware</title>
 
         <para>
             So far, all you have done is quickly built an image suitable
             for emulation only.
-            This section shows you how you can add a hardware layer into
-            the Yocto Project development environment.
+            This section shows you how to customize your build for specific
+            hardware by adding a hardware layer into the Yocto Project
+            development environment.
         </para>
 
         <para>
-            A hardware layer provides the metadata to support specific
-            hardware.
-            In general, layers are repositories that contain related sets
-            of instructions and configurations that tell the OpenEmbedded
-            build system what to do.
-            Isolating related metadata into layers facilitates modular
-            development.
+            In general, layers are repositories that contain related sets of
+            instructions and configurations that tell the OpenEmbedded build
+            system what to do.
+            Isolating related metadata into functionally specific layers
+            facilitates modular development and makes it easier to reuse the
+            layer metadata.
             <note>
-                By convention, hardware layers (i.e. Board Support Packages)
-                start with the string "meta-".
+                By convention, layer names start with the string "meta-".
             </note>
         </para>
 
@@ -327,7 +328,8 @@
      Resolving deltas: 100% (13385/13385), done.
      Checking connectivity... done.
                     </literallayout>
-                    The hardware layer now exists inside as
+                    The hardware layer now exists with other layers inside
+                    the Poky reference repository on your build host as
                     <filename>meta-altera</filename> and contains all the
                     metadata needed to support hardware from Altera, which
                     is owned by Intel.
@@ -340,7 +342,8 @@
                     specifies the machine for the build.
                     For this example, set the <filename>MACHINE</filename>
                     variable to "cyclone5".
-                    The build system will use the machine configurations here:
+                    The OpenEmbedded build system uses the machine
+                    configurations here:
                     <ulink url='https://github.com/kraj/meta-altera/blob/master/conf/machine/cyclone5.conf'></ulink>.
                     <note>
                         See the
@@ -358,7 +361,7 @@
                     <filename>conf</filename> directory.</para>
 
                     <para>Use the <filename>bitbake-layers add-layer</filename>
-                    command:
+                    command to add the layer to the configuration file:
                     <literallayout class='monospaced'>
      $ cd ~/poky/build
      $ bitbake-layers add-layer ../meta-altera
@@ -374,7 +377,7 @@
             Completing these steps has added the
             <filename>meta-altera</filename> layer to your Yocto Project
             development environment and configured it to build for the
-            "imx6sxsabresd" machine.
+            "cyclone5" machine.
             <note>
                 The previous steps are for demonstration purposes only.
                 If you were to attempt to build an image for the
@@ -384,13 +387,13 @@
         </para>
     </section>
 
-    <section id='adding-your-own-layer'>
-        <title>Adding Your Own Layer</title>
+    <section id='creating-your-own-general-layer'>
+        <title>Creating Your Own General Layer</title>
 
         <para>
             Maybe you have an application or specific set of behaviors you
             need to isolate.
-            You can create your own layer using the
+            You can create your own general layer using the
             <filename>bitbake-layers create-layer</filename> command.
             The tool automates layer creation by setting up a
             subdirectory with a <filename>layer.conf</filename>
-- 
cgit v1.2.3-54-g00ecf