summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual/sdk-appendix-obtain.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-01-26 07:18:13 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-03-23 21:56:07 +0000
commitd07100d5ff965030a31e1d28b5eec8ac91d68a3c (patch)
treef1c719bcae7465383e15befb6c0eda66a20b5eb7 /documentation/sdk-manual/sdk-appendix-obtain.xml
parentb750729ddf7933bd060a40058458c36dea0bb3d9 (diff)
downloadpoky-d07100d5ff965030a31e1d28b5eec8ac91d68a3c.tar.gz
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>
Diffstat (limited to 'documentation/sdk-manual/sdk-appendix-obtain.xml')
-rw-r--r--documentation/sdk-manual/sdk-appendix-obtain.xml85
1 files changed, 63 insertions, 22 deletions
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 @@
6 6
7<title>Obtaining the SDK</title> 7<title>Obtaining the SDK</title>
8 8
9<para> 9<section id='sdk-appendix-obtain-manual-development-notes'>
10 This chapter is going to cover the details on getting the SDK on your 10 <title>Manual Development Notes for Scott and Paul</title>
11 system. 11
12 It is debatable as to whether or not this should be an appendix. 12 <para>
13 It could be part of a main chapter I think. 13 This chapter is going to cover details about the installed SDK and perhaps
14 Originally suggested by Paul that it should be an appendix. 14 stuff on locating it (e.g. the naming scheme used to identify the
15 I have a sub-section in the main chapters to cover this should we 15 <filename>.sh</filename> installation script.
16 decide to place it there. 16 </para>
17</para> 17
18 18 <para>
19<para> 19 The idea here is to gather all the current information in the regular
20 The idea here is to gather all the current information in the regular 20 YP doc set that describes how to locate, download, or build out the SDK.
21 YP doc set that describes how to locate, download, or build out the SDK. 21 </para>
22</para> 22
23 23 <para>
24<para> 24 One thing that needs discussed is any differences between getting the
25 One thing that needs discussed is any differences between getting the 25 standard SDK as compared to the extended SDK.
26 standard SDK as compared to the extended SDK. 26 Do we have pre-build extensible SDKs laying around?
27 Do we have pre-build extensible SDKs laying around? 27 Where do we get any pre-built SDKs from?
28 Where do we get any pre-built SDKs from? 28 Show the methods by which the user builds out the SDK?
29 Show the methods by which the user builds out the SDK? 29 </para>
30</para> 30</section>
31
32<section id='sdk-installed-standard-sdk-directory-structure'>
33 <title>Installed Standard SDK Directory Structure</title>
34
35 <para>
36 The following figure shows the resulting directory structure after
37 you install the Standard SDK by running the <filename>.sh</filename>
38 SDK installation script:
39 </para>
40
41 <para>
42 <imagedata fileref="figures/sdk-installed-standard-sdk-directory.png" scale="60" align="center" />
43 </para>
44
45 <para>
46 The installed SDK consists of an environment setup script for the SDK,
47 a configuration file for the target, a version file for the target,
48 and the root filesystem (<filename>sysroots</filename>) needed to
49 develop objects for the target system.
50 </para>
51
52 <para>
53 Within the figure, italicized text is used to indicate replaceable
54 portions of the file or directory name.
55 For example,
56 <replaceable>install_dir</replaceable>/<replaceable>version</replaceable>
57 is the directory where the SDK is installed.
58 By default, this directory is <filename>/opt/poky/</filename>.
59 And, <replaceable>version</replaceable> represents the specific
60 snapshot of the SDK (e.g. <filename>&DISTRO;+snapshot</filename>).
61 Furthermore, <replaceable>target</replaceable> represents the target
62 architecture (e.g. <filename>i586</filename>) and
63 <replaceable>host</replaceable> represents the development system's
64 architecture (e.g. <filename>x86_64</filename>).
65 Thus, the complete names of the two directories within the
66 <filename>sysroots</filename> could be
67 <filename>i586-poky-linux</filename> and
68 <filename>x86_64-pokysdk-linux</filename> for the target and host,
69 respectively.
70 </para>
71</section>
31 72
32</appendix> 73</appendix>
33<!-- 74<!--