GNOME.org
 

[gnome-continuous-yocto/gnomeostree-3.28-rocko: 8/8267] sdk-manual: Applied review edits throughout the manual.

commit 64293699f66b1fdaf1fa4fc9eb6ee5878f629280
Author: Scott Rifenbark <srifenbark gmail com>
Date:   Tue Apr 19 12:00:51 2016 -0700

    sdk-manual: Applied review edits throughout the manual.
    
    Updates included minor items for wordings and clarity.  Review
    comments from David Kinder, Stephen Ballard, and Paul Eggleton.
    
    (From yocto-docs rev: b25e5cab60f9c1e059fadd844a3a75d9df450ebf)
    
    Signed-off-by: Scott Rifenbark <srifenbark gmail com>
    Signed-off-by: Richard Purdie <richard purdie linuxfoundation org>

 documentation/sdk-manual/sdk-appendix-obtain.xml |    4 +-
 documentation/sdk-manual/sdk-intro.xml           |   68 +++++++++++++--------
 documentation/sdk-manual/sdk-using.xml           |    8 +-
 3 files changed, 48 insertions(+), 32 deletions(-)
---
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.xml 
b/documentation/sdk-manual/sdk-appendix-obtain.xml
index 3d4e364..dc40cbf 100644
--- a/documentation/sdk-manual/sdk-appendix-obtain.xml
+++ b/documentation/sdk-manual/sdk-appendix-obtain.xml
@@ -168,7 +168,7 @@
 
     <para>
         The following figure shows the resulting directory structure after
-        you install the Standard SDK by running the <filename>.sh</filename>
+        you install the Standard SDK by running the <filename>*.sh</filename>
         SDK installation script:
     </para>
 
@@ -209,7 +209,7 @@
 
     <para>
         The following figure shows the resulting directory structure after
-        you install the Extensible SDK by running the <filename>.sh</filename>
+        you install the Extensible SDK by running the <filename>*.sh</filename>
         SDK installation script:
     </para>
 
diff --git a/documentation/sdk-manual/sdk-intro.xml b/documentation/sdk-manual/sdk-intro.xml
index 88ae778..d2a41ce 100644
--- a/documentation/sdk-manual/sdk-intro.xml
+++ b/documentation/sdk-manual/sdk-intro.xml
@@ -11,12 +11,12 @@
     <para>
         Welcome to the Yocto Project Software Development Kit (SDK)
         Developer's Guide.
-        This manual provides information that lets you use both the standard
-        Yocto Project SDK and an extensible SDK to develop applications and
-        images using the Yocto Project.
+        This manual provides information that explains how to use both the
+        standard Yocto Project SDK and an extensible SDK to develop
+        applications and images using the Yocto Project.
         Additionally, the manual also provides information on how to use
         the popular <trademark class='trade'>Eclipse</trademark> IDE as part
-        of your application development workflow.
+        of your application development workflow within the SDK environment.
     </para>
 
     <para>
@@ -30,11 +30,24 @@
     </para>
 
     <para>
-        A standard SDK consists of a cross-development toolchain that contains
-        a compiler, debugger, and various miscellaneous tools; libraries,
-        headers, and symbols to match an image; and environment setup script.
-        You can use this SDK to independently develop and test code that is
-        destined to run on some target machine.
+        A standard SDK consists of the following:
+        <itemizedlist>
+            <listitem><para><emphasis>Cross-Development Toolchain</emphasis>:
+                This toolchain contains a compiler, debugger, and various
+                miscellaneous tools.
+                </para></listitem>
+            <listitem><para><emphasis>Libraries, Headers, and Symbols</emphasis>:
+                The libraries, headers, and symbols are specific to the image
+                (i.e. they match the image).
+                </para></listitem>
+            <listitem><para><emphasis>Environment Setup Script</emphasis>:
+                This <filename>*.sh</filename> file, once run, sets up the
+                cross-development environment by defining variables and
+                preparing for SDK use.
+                </para></listitem>
+        </itemizedlist>
+        You can use the standard SDK to independently develop and test code
+        that is destined to run on some target machine.
     </para>
 
     <para>
@@ -59,7 +72,7 @@
     </para>
 
     <para>
-        Another feature for the SDKs is that only one set of cross-canadian
+        Another feature for the SDKs is that only one set of cross-compiler
         toolchain binaries are produced per architecture.
         This feature takes advantage of the fact that the target hardware can
         be passed to <filename>gcc</filename> as a set of compiler options.
@@ -74,12 +87,12 @@
     </para>
 
     <para>
-        Going beyond the actual SDK, the SDK development environment consists
-        of the following:
+        The SDK development environment consists of the following:
         <itemizedlist>
-            <listitem><para>An architecture-specific cross-toolchain and
+            <listitem><para>The self-contained SDK, which is an
+                architecture-specific cross-toolchain and
                 matching sysroots (target and native) all built by the
-                OpenEmbedded build system.
+                OpenEmbedded build system (e.g. the SDK).
                 The toolchain and sysroots are based on a
                 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
                 configuration and extensions,
@@ -91,10 +104,10 @@
                 QEMU is not literally part of the SDK.
                 You must build and include this emulator separately.
                 However, QEMU plays an important role in the development
-                process that revolves around use of and SDK.
+                process that revolves around use of the SDK.
                 </para></listitem>
             <listitem><para>The Eclipse IDE Yocto Plug-in.
-                This plug-in is also available for you if you are an Eclipse
+                This plug-in is available for you if you are an Eclipse
                 user.
                 In the same manner as QEMU, the plug-in is not literally part
                 of the SDK but is rather available for use as part of the
@@ -201,8 +214,8 @@
         <title>User-Space Tools</title>
 
         <para>
-            User-space tools are available as part of the SDK development
-            process and can be helpful.
+            User-space tools, which are available as part of the SDK
+            development environment, can be helpful.
             The tools include LatencyTOP, PowerTOP, Perf, SystemTap,
             and Lttng-ust.
             These tools are common development tools for the Linux platform.
@@ -264,7 +277,7 @@
         A developer can independently compile and test an object on their
         machine and then, when the object is ready for integration into an
         image, they can simply make it available to the machine that has the
-        the Yocto Project.
+        Yocto Project.
         Once the object is available, the image can be rebuilt using the
         Yocto Project to produce the modified image.
     </para>
@@ -303,12 +316,15 @@
                 64-bit architecture).
                 Download kernel, root filesystem, and any other files you
                 need for your process.
-                <note>In order to use the root filesystem in QEMU, you
-                need to extract it.
-                See the
-                "<link url='sdk-extracting-the-root-filesystem'>Extracting the Root Filesystem</link>"
-                section for information on how to extract the root
-                filesystem.</note></para></listitem>
+                <note>
+                    To use the root filesystem in QEMU, you
+                    need to extract it.
+                    See the
+                    "<link url='sdk-extracting-the-root-filesystem'>Extracting the Root Filesystem</link>"
+                    section for information on how to extract the root
+                    filesystem.
+                </note>
+                </para></listitem>
             <listitem><para><emphasis>Develop and Test your
                 Application:</emphasis>  At this point, you have the tools
                 to develop your application.
@@ -316,7 +332,7 @@
                 emulator, you can go to
                 <ulink url='http://wiki.qemu.org/Main_Page'>QEMU Home Page</ulink>
                 to download and learn about the emulator.
-                You can see the
+                See the
                 "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-qemu'>Using the Quick EMUlator (QEMU)</ulink>"
                 chapter in the Yocto Project Development Manual
                 for information on using QEMU within the Yocto
diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml
index 1ea47d3..a549284 100644
--- a/documentation/sdk-manual/sdk-using.xml
+++ b/documentation/sdk-manual/sdk-using.xml
@@ -14,7 +14,7 @@
         The tasks you can perform using a standard SDK are also applicable
         when you are using an extensible SDK.
         For information on the differences when using an extensible SDK as
-        compared to an extensible SDK, see the
+        compared to a standard SDK, see the
         "<link linkend='sdk-extensible'>Using the Extensible SDK</link>"
         chapter.
     </note>
@@ -46,7 +46,7 @@
 
     <para>
         The first thing you need to do is install the SDK on your host
-        development machine by running the <filename>.sh</filename>
+        development machine by running the <filename>*.sh</filename>
         installation script.
     </para>
 
@@ -382,8 +382,8 @@
         To illustrate this, consider the following four cross-toolchain
         environment variables:
         <literallayout class='monospaced'>
-     <ulink url='&YOCTO_DOCS_REF_URL;#var-CC'>CC</ulink>=i586-poky-linux-gcc -m32 -march=i586 
--sysroot=/opt/poky/1.8/sysroots/i586-poky-linux
-     <ulink url='&YOCTO_DOCS_REF_URL;#var-LD'>LD</ulink>=i586-poky-linux-ld 
--sysroot=/opt/poky/1.8/sysroots/i586-poky-linux
+     <ulink url='&YOCTO_DOCS_REF_URL;#var-CC'>CC</ulink>=i586-poky-linux-gcc -m32 -march=i586 
--sysroot=/opt/poky/&DISTRO;/sysroots/i586-poky-linux
+     <ulink url='&YOCTO_DOCS_REF_URL;#var-LD'>LD</ulink>=i586-poky-linux-ld 
--sysroot=/opt/poky/&DISTRO;/sysroots/i586-poky-linux
      <ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'>CFLAGS</ulink>=-O2 -pipe -g -feliminate-unused-debug-types
      <ulink url='&YOCTO_DOCS_REF_URL;#var-CXXFLAGS'>CXXFLAGS</ulink>=-O2 -pipe -g 
-feliminate-unused-debug-types
         </literallayout>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]