From d07100d5ff965030a31e1d28b5eec8ac91d68a3c Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Tue, 26 Jan 2016 07:18:13 -0800
Subject: sdk-manual: Added new section detailing installed SDK directory.

Added text and a new figure to show the resulting directory
structure from running the SDK installation .sh script.

(From yocto-docs rev: 3c5aec4a0088262e60ee6becb5e34552feeb6151)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/sdk-manual/sdk-appendix-obtain.xml | 85 ++++++++++++++++++------
 1 file changed, 63 insertions(+), 22 deletions(-)

(limited to 'documentation')

diff --git a/documentation/sdk-manual/sdk-appendix-obtain.xml b/documentation/sdk-manual/sdk-appendix-obtain.xml
index a9996c4d18..baf5dfd42f 100644
--- a/documentation/sdk-manual/sdk-appendix-obtain.xml
+++ b/documentation/sdk-manual/sdk-appendix-obtain.xml
@@ -6,28 +6,69 @@
 
 <title>Obtaining the SDK</title>
 
-<para>
-    This chapter is going to cover the details on getting the SDK on your
-    system.
-    It is debatable as to whether or not this should be an appendix.
-    It could be part of a main chapter I think.
-    Originally suggested by Paul that it should be an appendix.
-    I have a sub-section in the main chapters to cover this should we
-    decide to place it there.
-</para>
-
-<para>
-    The idea here is to gather all the current information in the regular
-    YP doc set that describes how to locate, download, or build out the SDK.
-</para>
-
-<para>
-    One thing that needs discussed is any differences between getting the
-    standard SDK as compared to the extended SDK.
-    Do we have pre-build extensible SDKs laying around?
-    Where do we get any pre-built SDKs from?
-    Show the methods by which the user builds out the SDK?
-</para>
+<section id='sdk-appendix-obtain-manual-development-notes'>
+    <title>Manual Development Notes for Scott and Paul</title>
+
+    <para>
+        This chapter is going to cover details about the installed SDK and perhaps
+        stuff on locating it (e.g. the naming scheme used to identify the
+        <filename>.sh</filename> installation script.
+    </para>
+
+    <para>
+        The idea here is to gather all the current information in the regular
+        YP doc set that describes how to locate, download, or build out the SDK.
+    </para>
+
+    <para>
+        One thing that needs discussed is any differences between getting the
+        standard SDK as compared to the extended SDK.
+        Do we have pre-build extensible SDKs laying around?
+        Where do we get any pre-built SDKs from?
+        Show the methods by which the user builds out the SDK?
+    </para>
+</section>
+
+<section id='sdk-installed-standard-sdk-directory-structure'>
+    <title>Installed Standard SDK Directory Structure</title>
+
+    <para>
+        The following figure shows the resulting directory structure after
+        you install the Standard SDK by running the <filename>.sh</filename>
+        SDK installation script:
+    </para>
+
+    <para>
+        <imagedata fileref="figures/sdk-installed-standard-sdk-directory.png" scale="60" align="center" />
+    </para>
+
+    <para>
+        The installed SDK consists of an environment setup script for the SDK,
+        a configuration file for the target, a version file for the target,
+        and the root filesystem (<filename>sysroots</filename>) needed to
+        develop objects for the target system.
+    </para>
+
+    <para>
+        Within the figure, italicized text is used to indicate replaceable
+        portions of the file or directory name.
+        For example,
+        <replaceable>install_dir</replaceable>/<replaceable>version</replaceable>
+        is the directory where the SDK is installed.
+        By default, this directory is <filename>/opt/poky/</filename>.
+        And, <replaceable>version</replaceable> represents the specific
+        snapshot of the SDK (e.g. <filename>&DISTRO;+snapshot</filename>).
+        Furthermore, <replaceable>target</replaceable> represents the target
+        architecture (e.g. <filename>i586</filename>) and
+        <replaceable>host</replaceable> represents the development system's
+        architecture (e.g. <filename>x86_64</filename>).
+        Thus, the complete names of the two directories within the
+        <filename>sysroots</filename> could be
+        <filename>i586-poky-linux</filename> and
+        <filename>x86_64-pokysdk-linux</filename> for the target and host,
+        respectively.
+    </para>
+</section>
 
 </appendix>
 <!--
-- 
cgit v1.2.3-54-g00ecf