summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-07-10 14:56:28 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-07-22 09:19:25 +0100
commit5731def9011cd77b0a984cdb8e86e12c9f8c12ce (patch)
treec8281536cc7faccd88252233d9824609b35dbf10 /documentation
parent8b04dca4556ef0922c1f649dde05ce83926f8b34 (diff)
downloadpoky-5731def9011cd77b0a984cdb8e86e12c9f8c12ce.tar.gz
sdk-manual: Converted SDK build section to procedure
The section needed to be a step-by-step procedure. (From yocto-docs rev: de4868c97c1199b39b3c3e68b4ff159f6546cd9e) 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.xml141
1 files changed, 85 insertions, 56 deletions
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.xml b/documentation/sdk-manual/sdk-appendix-obtain.xml
index 3fae8052ac..ae30995304 100644
--- a/documentation/sdk-manual/sdk-appendix-obtain.xml
+++ b/documentation/sdk-manual/sdk-appendix-obtain.xml
@@ -91,65 +91,94 @@
91 91
92 <para> 92 <para>
93 As an alternative to locating and downloading a SDK installer, 93 As an alternative to locating and downloading a SDK installer,
94 you can build the SDK installer assuming you have first sourced 94 you can build the SDK installer.
95 the environment setup script. 95 Follow these steps:
96 See the 96 <orderedlist>
97 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" 97 <listitem><para>
98 section in the Yocto Project Quick Start for steps that show you 98 <emphasis>Set Up the Build Environment:</emphasis>
99 how to set up the Yocto Project environment. 99 Be sure you are set up to use BitBake in a shell.
100 In particular, you need to be sure the 100 See the
101 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> 101 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
102 variable matches the architecture for which you are building and that 102 section in the Yocto Project Quick Start for steps that
103 the 103 show you how to set up the Yocto Project environment.
104 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink> 104 </para></listitem>
105 variable is correctly set if you are building a toolchain designed to 105 <listitem><para>
106 run on an architecture that differs from your current development host 106 <emphasis>Make Sure You Are Building an Installer for the Correct Machine:</emphasis>
107 machine (i.e. the build machine). 107 Check to be sure that your
108 </para> 108 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
109 109 variable in the <filename>local.conf</filename> file in your
110 <para> 110 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
111 To build the SDK installer for a standard SDK and populate 111 matches the architecture for which you are building.
112 the SDK image, use the following command: 112 </para></listitem>
113 <literallayout class='monospaced'> 113 <listitem><para>
114 <emphasis>Make Sure Your SDK Machine is Correctly Set:</emphasis>
115 If you are building a toolchain designed to run on an
116 architecture that differs from your current development host
117 machine (i.e. the build machine), be sure that the
118 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink>
119 variable in the <filename>local.conf</filename> file in your
120 Build Directory is correctly set.
121 </para></listitem>
122 <listitem><para>
123 <emphasis>Build the SDK Installer:</emphasis>
124 To build the SDK installer for a standard SDK and populate
125 the SDK image, use the following command form.
126 Be sure to replace <replaceable>image</replaceable> with
127 an image (e.g. "core-image-sato"):
128 <literallayout class='monospaced'>
114 $ bitbake <replaceable>image</replaceable> -c populate_sdk 129 $ bitbake <replaceable>image</replaceable> -c populate_sdk
115 </literallayout> 130 </literallayout>
116 You can do the same for the extensible SDK using this command: 131 You can do the same for the extensible SDK using this command
117 <literallayout class='monospaced'> 132 form:
133 <literallayout class='monospaced'>
118 $ bitbake <replaceable>image</replaceable> -c populate_sdk_ext 134 $ bitbake <replaceable>image</replaceable> -c populate_sdk_ext
119 </literallayout> 135 </literallayout>
120 These commands result in a SDK installer that contains the sysroot 136 These commands result in a SDK installer that contains the
121 that matches your target root filesystem. 137 sysroot that matches your target root filesystem.</para>
122 </para> 138
123 139 <para>When the <filename>bitbake</filename> command completes,
124 <para> 140 the SDK installer will be in
125 When the <filename>bitbake</filename> command completes, the SDK 141 <filename>tmp/deploy/sdk</filename> in the Build Directory.
126 installer will be in 142 <note><title>Notes</title>
127 <filename>tmp/deploy/sdk</filename> in the Build Directory. 143 <itemizedlist>
128 <note><title>Notes</title> 144 <listitem><para>
129 <itemizedlist> 145 By default, this toolchain does not build static
130 <listitem><para> 146 binaries.
131 By default, this toolchain does not build static binaries. 147 If you want to use the toolchain to build these
132 If you want to use the toolchain to build these types of 148 types of libraries, you need to be sure your SDK
133 libraries, you need to be sure your SDK has the 149 has the appropriate static development libraries.
134 appropriate static development libraries. 150 Use the
135 Use the 151 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink>
136 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink> 152 variable inside your <filename>local.conf</filename>
137 variable inside your <filename>local.conf</filename> file 153 file to install the appropriate library packages
138 to install the appropriate library packages in the SDK. 154 in the SDK.
139 Following is an example using <filename>libc</filename> 155 Following is an example using
140 static development libraries: 156 <filename>libc</filename> static development
141 <literallayout class='monospaced'> 157 libraries:
158 <literallayout class='monospaced'>
142 TOOLCHAIN_TARGET_TASK_append = " libc-staticdev" 159 TOOLCHAIN_TARGET_TASK_append = " libc-staticdev"
143 </literallayout> 160 </literallayout>
144 </para></listitem> 161 </para></listitem>
145 <listitem><para> 162 <listitem><para>
146 For additional information on building the installer, 163 For additional information on building the
147 see the 164 installer, see the
148 <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>Cookbook guide to Making an Eclipse Debug Capable Image</ulink> 165 <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>Cookbook guide to Making an Eclipse Debug Capable Image</ulink>
149 wiki page. 166 wiki page.
150 </para></listitem> 167 </para></listitem>
151 </itemizedlist> 168 </itemizedlist>
152 </note> 169 </note>
170 </para></listitem>
171 <listitem><para>
172 <emphasis>Run the Installer:</emphasis>
173 You can now run the SDK installer from
174 <filename>tmp/deploy/sdk</filename> in the Build Directory.
175 Following is an example:
176 <literallayout class='monospaced'>
177 $ cd ~/poky/build/tmp/deploy/sdk
178 ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
179 </literallayout>
180 </para></listitem>
181 </orderedlist>
153 </para> 182 </para>
154</section> 183</section>
155 184