summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-24 22:11:10 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-03-25 12:29:45 (GMT)
commitb990aa8b1bf014fcc662da744f595f44eb8352b9 (patch)
treee9bfe9913cce58046f4e8eb2979e288ba4164a59
parent752bf31c85a42873c9244f62bf13483dda4569c2 (diff)
downloadpoky-b990aa8b1bf014fcc662da744f595f44eb8352b9.tar.gz
ref-manual, yocto-project-qs: Notes and infor for buildtools issues
Fixes [YOCTO #4866] Updated the main area where it talks about needing the right versions of Git, tar, and Python. You can get this set up using a couple methods. I documented both. The changes in the FAQ and in the QS are basically notes that point to that section for more information. (From yocto-docs rev: 1b64c7c271303ecf10ec85c8a2cd5a0d909f1151) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/faq.xml9
-rw-r--r--documentation/ref-manual/introduction.xml183
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml12
3 files changed, 143 insertions, 61 deletions
diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml
index ff695ba..035011f 100644
--- a/documentation/ref-manual/faq.xml
+++ b/documentation/ref-manual/faq.xml
@@ -30,9 +30,12 @@
30 30
31 <qandaentry> 31 <qandaentry>
32 <question> 32 <question>
33 <para> 33 <para id='faq-not-meeting-requirements'>
34 My development system does not have Python 2.7.3 or greater, 34 My development system does not meet the
35 which the Yocto Project requires. 35 required Git, tar, and Python versions.
36 In particular, I do not have Python 2.7.3 or greater, or
37 I do have Python 3.x, which is specifically not supported by
38 the Yocto Project.
36 Can I still use the Yocto Project? 39 Can I still use the Yocto Project?
37 </para> 40 </para>
38 </question> 41 </question>
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml
index 47f7362..7eb8203 100644
--- a/documentation/ref-manual/introduction.xml
+++ b/documentation/ref-manual/introduction.xml
@@ -338,63 +338,142 @@
338 338
339 <para> 339 <para>
340 If your host development system does not meet all these requirements, 340 If your host development system does not meet all these requirements,
341 you can resolve this by either downloading a pre-built tarball 341 you can resolve this by installing a <filename>buildtools</filename>
342 containing these tools, or building such a tarball on another 342 tarball that contains these tools.
343 system. 343 You can get the tarball one of two ways: download a pre-built
344 Regardless of the method, once you have the tarball, you simply 344 tarball or use BitBake to build the tarball.
345 install it somewhere on your system, such as a directory in your
346 home directory, and then source the environment script provided,
347 which adds the tools into <filename>PATH</filename> and sets
348 any other environment variables required to run the tools.
349 Doing so gives you working versions of Git, tar, Python and
350 <filename>chrpath</filename>.
351 </para> 345 </para>
352 346
353 <para> 347 <section id='downloading-a-pre-built-buildtools-tarball'>
354 If downloading a pre-built tarball, locate the 348 <title>Downloading a Pre-Built <filename>buildtools</filename> Tarball</title>
355 <filename>*.sh</filename> at
356 <ulink url='&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;/buildtools/'></ulink>.
357 </para>
358 349
359 <para> 350 <para>
360 If building your own tarball, do so using this command: 351 Downloading and running a pre-built buildtools installer is
361 <literallayout class='monospaced'> 352 the easiest of the two methods by which you can get these tools:
362 $ bitbake buildtools-tarball 353 <orderedlist>
363 </literallayout> 354 <listitem><para>
364 <note> 355 Locate and download the <filename>*.sh</filename> at
365 The <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link> 356 <ulink url='&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;/buildtools/'></ulink>.
366 variable determines whether you build tools for a 32-bit 357 </para></listitem>
367 or 64-bit system. 358 <listitem><para>
368 </note> 359 Execute the installation script.
369 Once the build completes, you can find the file that installs 360 Here is an example:
370 the tools in the <filename>tmp/deploy/sdk</filename> subdirectory 361 <literallayout class='monospaced'>
371 of the 362 $ sh poky-eglibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
372 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 363 </literallayout>
373 The file used to install the tarball has the string "buildtools" 364 During execution, a prompt appears that allows you to
374 in the name. 365 choose the installation directory.
375 </para> 366 For example, you could choose the following:
367 <literallayout class='monospaced'>
368 /home/your-username/buildtools
369 </literallayout>
370 </para></listitem>
371 <listitem><para>
372 Source the tools environment setup script by using a
373 command like the following:
374 <literallayout class='monospaced'>
375 $ source /home/your-username/buildtools/environment-setup-i586-poky-linux
376 </literallayout>
377 Of course, you need to supply your installation directory and be
378 sure to use the right file (i.e. i585 or x86-64).
379 </para>
380 <para>
381 After you have sourced the setup script,
382 the tools are added to <filename>PATH</filename>
383 and any other environment variables required to run the
384 tools are initialized.
385 The results are working versions versions of Git, tar,
386 Python and <filename>chrpath</filename>.
387 </para></listitem>
388 </orderedlist>
389 </para>
390 </section>
376 391
377 <para> 392 <section id='building-your-own-buildtools-tarball'>
378 After you have either built the tarball or downloaded it, you need 393 <title>Building Your Own <filename>buildtools</filename> Tarball</title>
379 to install it.
380 Install the tools by executing the <filename>*.sh</filename> file.
381 During execution, a prompt appears that allows you to choose the
382 installation directory.
383 For example, you could choose the following:
384 <literallayout class='monospaced'>
385 /home/your-username/sdk
386 </literallayout>
387 </para>
388 394
389 <para> 395 <para>
390 The final step before you can actually use the tools is to source 396 Building and running your own buildtools installer applies
391 the tools environment with a command like the following: 397 only when you have a build host that can already run BitBake.
392 <literallayout class='monospaced'> 398 In this case, you use that machine to build the
393 $ source /home/your-username/sdk/environment-setup-i586-poky-linux 399 <filename>.sh</filename> file and then
394 </literallayout> 400 take steps to transfer and run it on a
395 Of course, you need to supply your installation directory and be 401 machine that does not meet the minimal Git, tar, and Python
396 sure to use the right file (i.e. i585 or x86-64). 402 requirements.
397 </para> 403 </para>
404
405 <para>
406 Here are the steps to take to build and run your own
407 buildtools installer:
408 <orderedlist>
409 <listitem><para>
410 On the machine that is able to run BitBake,
411 be sure you have set up your build environment with
412 the setup script
413 (<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
414 or
415 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
416 </para></listitem>
417 <listitem><para>
418 Run the BitBake command to build the tarball:
419 <literallayout class='monospaced'>
420 $ bitbake buildtools-tarball
421 </literallayout>
422 <note>
423 The
424 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>
425 variable in your <filename>local.conf</filename> file
426 determines whether you build tools for a 32-bit
427 or 64-bit system.
428 </note>
429 Once the build completes, you can find the
430 <filename>.sh</filename> file that installs
431 the tools in the <filename>tmp/deploy/sdk</filename>
432 subdirectory of the
433 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
434 The installer file has the string "buildtools"
435 in the name.
436 </para></listitem>
437 <listitem><para>
438 Transfer the <filename>.sh</filename> file from the
439 build host to the machine that does not meet the
440 Git, tar, or Python requirements.
441 </para></listitem>
442 <listitem><para>
443 On the machine that does not meet the requirements,
444 run the <filename>.sh</filename> file
445 to install the tools.
446 Here is an example:
447 <literallayout class='monospaced'>
448 $ sh poky-eglibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
449 </literallayout>
450 During execution, a prompt appears that allows you to
451 choose the installation directory.
452 For example, you could choose the following:
453 <literallayout class='monospaced'>
454 /home/your-username/buildtools
455 </literallayout>
456 </para></listitem>
457 <listitem><para>
458 Source the tools environment setup script by using a
459 command like the following:
460 <literallayout class='monospaced'>
461 $ source /home/your-username/buildtools/environment-setup-i586-poky-linux
462 </literallayout>
463 Of course, you need to supply your installation directory and be
464 sure to use the right file (i.e. i585 or x86-64).
465 </para>
466 <para>
467 After you have sourced the setup script,
468 the tools are added to <filename>PATH</filename>
469 and any other environment variables required to run the
470 tools are initialized.
471 The results are working versions versions of Git, tar,
472 Python and <filename>chrpath</filename>.
473 </para></listitem>
474 </orderedlist>
475 </para>
476 </section>
398 </section> 477 </section>
399</section> 478</section>
400 479
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index d86518e..393da95 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -533,12 +533,12 @@
533 <literallayout class='monospaced'> 533 <literallayout class='monospaced'>
534 $ bitbake -k core-image-sato 534 $ bitbake -k core-image-sato
535 </literallayout> 535 </literallayout>
536 <note><para> 536 <note>
537 BitBake requires Python 2.6 or 2.7. For more information on this requirement, 537 BitBake requires Python 2.6 or 2.7. For more information on
538 see the 538 this requirement, see the
539 <ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> in the Yocto Project Reference 539 "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python</ulink>"
540 Manual. 540 section in the Yocto Project Reference Manual.
541 </para></note> 541 </note>
542 The final command runs the image: 542 The final command runs the image:
543 <literallayout class='monospaced'> 543 <literallayout class='monospaced'>
544 $ runqemu qemux86 544 $ runqemu qemux86