summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-06-28 16:33:28 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-08-13 13:18:35 +0100
commitc56c79fd3599f1f13e7e0e49f3cf47d7f224131b (patch)
tree816573bce9cf9a216883ea3eee603181bb12df6c /documentation/ref-manual
parent222a9cfa34811fdba7f00fa0c59b12adfd103d68 (diff)
downloadpoky-c56c79fd3599f1f13e7e0e49f3cf47d7f224131b.tar.gz
ref-manual: New section on building buildtools tarball
Fixes YOCTO #4753 This is the main change to address this bug. It is a new section that describes how the user can get a buildtools tarball if their system does not meet the proper Git, tar, and Python versioning. (From yocto-docs rev: 0493a55c85f050ba29f605ab727e557849242bae) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/introduction.xml72
1 files changed, 72 insertions, 0 deletions
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml
index 69b742244f..566fa5a9cf 100644
--- a/documentation/ref-manual/introduction.xml
+++ b/documentation/ref-manual/introduction.xml
@@ -290,6 +290,78 @@
290 </para> 290 </para>
291 </section> 291 </section>
292 </section> 292 </section>
293
294 <section id='required-git-tar-and-python-versions'>
295 <title>Required Git, tar, and Python Versions</title>
296
297 <para>
298 In order to use the build system, your host development system
299 must meet the following version requirements for Git, tar, and
300 Python:
301 <itemizedlist>
302 <listitem><para>Git 1.7.5 or greater</para></listitem>
303 <listitem><para>tar 1.24 or greater</para></listitem>
304 <listitem><para>Python 2.7.3 or greater</para></listitem>
305 </itemizedlist>
306 </para>
307
308 <para>
309 If your host development system does not meet all these requirements,
310 you can resolve this by either downloading a pre-built tarball
311 containing these tools, or building such a tarball on another
312 system.
313 Regardless of the method, once you have the tarball you simply
314 install it somewhere on you system, such as a directory in your
315 home directory, and then source the envirnoment script provided,
316 which adds the tools into <filename>PATH</filename>.
317 Doing so gives you working versions of Git, tar, Python and
318 <filename>chrpath</filename>.
319 </para>
320
321 <para>
322 If downloading a pre-built tarball, locate the
323 <filename>*.sh</filename> at [NEED A PATH HERE from Beth].
324 </para>
325
326 <para>
327 If building your own tarball, do so using this command:
328 <literallayout class='monospaced'>
329 $ bitbake buildtools-tarball
330 </literallayout>
331 <note>
332 The <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>
333 variable determines whether you build tools for a 32-bit
334 or 64-bit system.
335 </note>
336 Once the build completes, you can find the file that installs the
337 the tools in <filename>tmp/deploy/sdk</filename> of the
338 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
339 The file used to install the tarball has the string "buildtools"
340 in the name.
341 </para>
342
343 <para>
344 After you have either built the tarball or downloaded it, you need
345 to install it.
346 Install the tools by executing the <filename>*.sh</filename> file.
347 During execution, a prompt appears that allows you to choose the
348 installation directory.
349 For example, you could choose the following:
350 <literallayout class='monospaced'>
351 /home/your-username/sdk
352 </literallayout>
353 </para>
354
355 <para>
356 The final step before you can actually use the tools is to source
357 the tools environment with a command like the following:
358 <literallayout class='monospaced'>
359 $ source /home/your-username/sdk/environment-setup-i586-poky-linux
360 </literallayout>
361 Of course, you need to supply your installation directory and be
362 sure to use the right file (i.e. i585 or x86-64).
363 </para>
364 </section>
293</section> 365</section>
294 366
295<section id='intro-getit'> 367<section id='intro-getit'>