sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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>
This commit is contained in:
Scott Rifenbark 2016-01-26 07:18:13 -08:00 committed by Richard Purdie
parent b750729ddf
commit d07100d5ff
1 changed files with 61 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
documentation/sdk-manual/sdk-appendix-obtain.xml
View File

@ -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>
<section id='sdk-appendix-obtain-manual-development-notes'>
<title>Manual Development Notes for Scott and Paul</title>
<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>
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>
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>
<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>
<!--