summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-01-25 15:14:57 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-03-23 21:56:07 +0000
commit890f7215f015385762bce7c97b192f6a68d74585 (patch)
tree16ef33a768cfd9d4bfd7d69d9da2d463c652454f /documentation
parentf15f96c07ebf9468001c63a35b688311787f3467 (diff)
downloadpoky-890f7215f015385762bce7c97b192f6a68d74585.tar.gz
sdk-manual: WIP - Various small edits as WIP
(From yocto-docs rev: 53c16de81028d5564a75b4787203d6862258f68e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/sdk-manual/sdk-appendix-obtain.xml6
-rw-r--r--documentation/sdk-manual/sdk-extensible.xml54
-rw-r--r--documentation/sdk-manual/sdk-intro.xml39
-rw-r--r--documentation/sdk-manual/sdk-using.xml54
4 files changed, 128 insertions, 25 deletions
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.xml b/documentation/sdk-manual/sdk-appendix-obtain.xml
index fbdb240368..a9996c4d18 100644
--- a/documentation/sdk-manual/sdk-appendix-obtain.xml
+++ b/documentation/sdk-manual/sdk-appendix-obtain.xml
@@ -12,6 +12,8 @@
12 It is debatable as to whether or not this should be an appendix. 12 It is debatable as to whether or not this should be an appendix.
13 It could be part of a main chapter I think. 13 It could be part of a main chapter I think.
14 Originally suggested by Paul that it should be an appendix. 14 Originally suggested by Paul that it should be an appendix.
15 I have a sub-section in the main chapters to cover this should we
16 decide to place it there.
15</para> 17</para>
16 18
17<para> 19<para>
@@ -22,8 +24,8 @@
22<para> 24<para>
23 One thing that needs discussed is any differences between getting the 25 One thing that needs discussed is any differences between getting the
24 standard SDK as compared to the extended SDK. 26 standard SDK as compared to the extended SDK.
25 Do we have pre-build extended SDKs laying around? 27 Do we have pre-build extensible SDKs laying around?
26 Where do we get any pre-build SDKs from? 28 Where do we get any pre-built SDKs from?
27 Show the methods by which the user builds out the SDK? 29 Show the methods by which the user builds out the SDK?
28</para> 30</para>
29 31
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml
index 4236b165b5..a04164a413 100644
--- a/documentation/sdk-manual/sdk-extensible.xml
+++ b/documentation/sdk-manual/sdk-extensible.xml
@@ -7,22 +7,56 @@
7<title>Using the Extensible SDK</title> 7<title>Using the Extensible SDK</title>
8 8
9<para> 9<para>
10 This chapter is going to cover all the SDK stuff that is unique 10 This chapter describes what you need on your machine in order to use
11 to the extensible SDK. 11 an extensible SDK.
12 The chapter does not repeat information that also applies to using the
13 standard SDK.
14 The chapter also includes procedures of tasks you can perform using
15 an extensible SDK.
16 <note>
17 The tasks you can perform using a standard SDK are also available
18 using an extensible SDK.
19 For information on using the standard SDK, see the
20 "<link linkend='sdk-using-the-standard-sdk'>Using the Standard SDK</link>"
21 chapter.
22 </note>
12</para> 23</para>
13 24
25
14<section id='sdk-setting-up-to-use-the-extensible-sdk'> 26<section id='sdk-setting-up-to-use-the-extensible-sdk'>
15 <title>Setting Up to Use the Extensible SDK</title> 27 <title>Setting Up to Use the Extensible SDK</title>
16 28
17 <para> 29 <para>
18 What do you need to use the extensible SDK that is different from 30 Here is a list of items I think need addressed in this section:
19 the standard SDK? 31 <itemizedlist>
20 What does your system have to have on it? 32 <listitem><para><emphasis>Cover differences in the development
21 What are the recommendations? 33 that might be impacted because they are using an extensible
22 What conditions in your development scenario warrant use of just the 34 SDK</emphasis></para>
23 extensible SDK? 35 <para>Presumably, the various development scenarios are
24 Show any specific procedures needed to get set up to use the 36 covered regarding setup in the previous chapter.
25 extensible SDK. 37 Are these impacted because the developer is going to now be
38 using an extensible SDK?
39 If so, what are the implications?
40 </para></listitem>
41 <listitem><para><emphasis>What new recommendations exist now that
42 the developer is going to be using an extensible SDK?</emphasis></para>
43 <para>We should cover the most common development scenarios
44 that apply when using an extensible SDK.
45 Is there a recommended development flow we want to present
46 when using an extensible SDK?
47 What conditions in a development scenario warrant use of
48 the extensible SDK as compared to the standard SDK?
49 </para></listitem>
50 <listitem><para><emphasis>What procedures do we want to cover to set
51 up the extensible SDK?</emphasis></para>
52 <para>Is it just a matter of building out the SDK using
53 <filename>bitbake -c populate_sdk_ext</filename>?
54 Is there a pre-built extensible SDK laying around they can
55 find and download if they are using a machine that does not
56 have YP installed, which would prevent them from building their
57 own SDK?
58 </para></listitem>
59 </itemizedlist>
26 </para> 60 </para>
27</section> 61</section>
28 62
diff --git a/documentation/sdk-manual/sdk-intro.xml b/documentation/sdk-manual/sdk-intro.xml
index 99f807e056..5b12fcff64 100644
--- a/documentation/sdk-manual/sdk-intro.xml
+++ b/documentation/sdk-manual/sdk-intro.xml
@@ -27,7 +27,19 @@
27 </para> 27 </para>
28 28
29 <para> 29 <para>
30 Describe what a standard SDK is as compared to the extensible SDK. 30 A standard SDK consists of a cross-development toolchain that contains
31 a compiler, debugger, and various miscellaneous tools; libraries,
32 headers, and symbols to match an image; and environment setup script.
33 You can use this SDK to independently develop and test code that is
34 destined to run on some target machine.
35 </para>
36
37 <para>
38 An extensible SDK consists of everything that the standard SDK has plus
39 tools that allow you to easily add new applications and libraries to
40 an image, modify the source of an existing component, test changes on
41 the target hardware, and easily integrate an application into the
42 the Yocto Project build system.
31 </para> 43 </para>
32</section> 44</section>
33 45
@@ -35,10 +47,27 @@
35 <title>SDK Development Model</title> 47 <title>SDK Development Model</title>
36 48
37 <para> 49 <para>
38 * Development Model - provide a figure that shows the development 50 Fundamentally, the SDK fits into the development process as follows:
39 pieces using boxes and arrows. 51 <imagedata fileref="figures/sdk-environment.png" align="center" width="6in" depth="5in" scalefit="100" />
40 Include all possible methods, inputs and outputs. 52 The SDK is installed on any machine and can be used to develop
41 <imagedata fileref="figures/sdk-environment.png" align="center" width="6in" depth="5in" scalefit="100" /> 53 applications, images, and kernels.
54 An SDK can even be used by a QA Engineer or Release Engineer.
55 The fundamental concept is that the machine that has the SDK installed
56 does not have to be associated with the machine that has the
57 Yocto Project installed.
58 A developer can independently compile and test an object on their
59 machine and then, when the object is ready for integration into an
60 image, they can simply make it available to the machine that has the
61 the Yocto Project.
62 Once the object is available, the image can be rebuilt using the
63 Yocto Project to produce the modified image.
64 </para>
65
66 <para>
67 The remainder of this manual describes how to use both the standard
68 SDK and the extensible SDK.
69 Information also exists in appendix form that describes how you can
70 build, install, and modify an SDK.
42 </para> 71 </para>
43</section> 72</section>
44 73
diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml
index eb024f917c..e3dc6e22a1 100644
--- a/documentation/sdk-manual/sdk-using.xml
+++ b/documentation/sdk-manual/sdk-using.xml
@@ -7,20 +7,58 @@
7<title>Using the Standard SDK</title> 7<title>Using the Standard SDK</title>
8 8
9<para> 9<para>
10 This chapter is going to cover all the SDK stuff that is common 10 This chapter describes how to use a standard SDK.
11 to both the SDK and the extensible SDK. 11 Information covers installing the SDK and task-based procedures common
12 for developing with a standard SDK.
13 <note>
14 The tasks you can perform using a standard SDK are also applicable
15 when you are using an extensible SDK.
16 For information on the differences when using an extensible SDK as
17 compared to an extensible SDK, see the
18 "<link linkend='sdk-extensible'>Using the Extensible SDK</link>"
19 chapter.
20 </note>
12</para> 21</para>
13 22
14<section id='sdk-setting-up-to-use-the-standard-sdk'> 23<section id='sdk-setting-up-to-use-the-standard-sdk'>
15 <title>Setting Up to Use the Standard SDK</title> 24 <title>Setting Up to Use the Standard SDK</title>
16 25
17 <para> 26 <para>
18 What do you need to use the SDK? 27 Here is a list of items I think need addressed in this section:
19 What does your system have to have on it? 28 <itemizedlist>
20 What are the recommendations? 29 <listitem><para><emphasis>What is your situation?</emphasis></para>
21 What conditions in your development scenario warrant use of just the 30 <para>In other words, is the developer on a machine that
22 standard SDK as compared to the extensible SDK? 31 has YP on it?
23 Show any specific procedures needed to get set up to use the SDK. 32 Are they on a machine that does not?
33 Is the image they are developing against available as a
34 pre-built, down-loadable image and can they get it?</para>
35 <para>Depending on the scenario, there are different ways
36 to make sure the machine they are using is ready to use a
37 standard SDK.
38 I think we need to cover the various situations in this
39 section.
40 </para></listitem>
41 <listitem><para><emphasis>What are the recommendations?</emphasis></para>
42 <para>What is the most common development scenario?
43 Is there a recommended development flow we want to present
44 when using a standard SDK?
45 What conditions in a development scenario warrant use of
46 just the standard SDK as compared to the extensible SDK?
47 </para></listitem>
48 <listitem><para><emphasis>What procedures do we want to cover to set up
49 the standard SDK?</emphasis></para>
50 <para>There is a ton of setup information in the
51 current ADT manual regarding getting, building, and installing
52 an SDK.
53 We would ignore the stuff about the ADT installer script
54 since I presume that is going away.
55 But, there are steps to download and existing
56 <filename>.sh</filename> install script, build out the
57 toolchains assuming your system has YP on it and you can run
58 BitBake, getting the root filesystem, getting an image so you
59 run QEMU on your system, etc.
60 </para></listitem>
61 </itemizedlist>
24 </para> 62 </para>
25</section> 63</section>
26 64