summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTim Orling <timothy.t.orling@linux.intel.com>2020-04-03 00:55:55 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-04-06 13:40:25 (GMT)
commit07aaa69d57290637d146ea26baf4aeeec7e10138 (patch)
treeb6894f9d2076755217f3bfb8e888131f7f06e373
parente75301e0182301423defc1b7f59fe4fad761d206 (diff)
downloadpoky-07aaa69d57290637d146ea26baf4aeeec7e10138.tar.gz
ref-manual: add install-buildtools and -extended
Add instructions to use 'install-buildtools' and 'buildtools-extended-tarball'. Add gcc 5.0 requirement and call out how to use above to prepare host development system. (From yocto-docs rev: c6dbd9bf6860ffea1bc025907343373439d91737) Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/faq.xml4
-rw-r--r--documentation/ref-manual/migration.xml6
-rw-r--r--documentation/ref-manual/ref-system-requirements.xml127
3 files changed, 120 insertions, 17 deletions
diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml
index 49ff862..d94cb32 100644
--- a/documentation/ref-manual/faq.xml
+++ b/documentation/ref-manual/faq.xml
@@ -33,7 +33,7 @@
33 <para id='faq-not-meeting-requirements'> 33 <para id='faq-not-meeting-requirements'>
34 My development system does not meet the 34 My development system does not meet the
35 required Git, tar, and Python versions. 35 required Git, tar, and Python versions.
36 In particular, I do not have Python 3.4.0 or greater. 36 In particular, I do not have Python 3.5.0 or greater.
37 Can I still use the Yocto Project? 37 Can I still use the Yocto Project?
38 </para> 38 </para>
39 </question> 39 </question>
@@ -43,7 +43,7 @@
43 system a couple different ways (i.e. building a tarball or 43 system a couple different ways (i.e. building a tarball or
44 downloading a tarball). 44 downloading a tarball).
45 See the 45 See the
46 "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" 46 "<link linkend='required-git-tar-python-and-gcc-versions'>Required Git, tar, Python and gcc Versions</link>"
47 section for steps on how to update your build tools. 47 section for steps on how to update your build tools.
48 </para> 48 </para>
49 </answer> 49 </answer>
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index 80a6acc..03efc7b 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -680,7 +680,7 @@
680 680
681 <para> 681 <para>
682 For more information on this requirement, see the 682 For more information on this requirement, see the
683 "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" 683 "<link linkend='required-git-tar-python-and-gcc-versions'>Required Git, tar, Python and gcc Versions</link>"
684 section. 684 section.
685 </para> 685 </para>
686 </section> 686 </section>
@@ -1754,7 +1754,7 @@
1754 Git that meets this requirement, you can use the 1754 Git that meets this requirement, you can use the
1755 <filename>buildtools-tarball</filename> that does. 1755 <filename>buildtools-tarball</filename> that does.
1756 See the 1756 See the
1757 "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" 1757 "<link linkend='required-git-tar-python-and-gcc-versions'>Required Git, tar, Python and gcc Versions</link>"
1758 section for more information. 1758 section for more information.
1759 </para> 1759 </para>
1760 </section> 1760 </section>
@@ -3215,7 +3215,7 @@
3215 recent version, you can install the buildtools, which 3215 recent version, you can install the buildtools, which
3216 will provide it. 3216 will provide it.
3217 See the 3217 See the
3218 "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" 3218 "<link linkend='required-git-tar-python-and-gcc-versions'>Required Git, tar, Python and gcc Versions</link>"
3219 section for more information on the buildtools tarball. 3219 section for more information on the buildtools tarball.
3220 </para></listitem> 3220 </para></listitem>
3221 <listitem><para> 3221 <listitem><para>
diff --git a/documentation/ref-manual/ref-system-requirements.xml b/documentation/ref-manual/ref-system-requirements.xml
index 6153117..2c01996 100644
--- a/documentation/ref-manual/ref-system-requirements.xml
+++ b/documentation/ref-manual/ref-system-requirements.xml
@@ -315,8 +315,8 @@
315 </section> 315 </section>
316 </section> 316 </section>
317 317
318 <section id='required-git-tar-and-python-versions'> 318 <section id='required-git-tar-python-and-gcc-versions'>
319 <title>Required Git, tar, and Python Versions</title> 319 <title>Required Git, tar, Python and gcc Versions</title>
320 320
321 <para> 321 <para>
322 In order to use the build system, your host development system 322 In order to use the build system, your host development system
@@ -337,6 +337,89 @@
337 tarball or use BitBake to build the tarball. 337 tarball or use BitBake to build the tarball.
338 </para> 338 </para>
339 339
340 <para>
341 In addition, your host development system must meet the following
342 version requirement for gcc:
343 <itemizedlist>
344 <listitem><para>gcc 5.0 or greater</para></listitem>
345 </itemizedlist>
346 </para>
347
348 <para>
349 If your host development system does not meet this requirement,
350 you can resolve this by installing a <filename>buildtools-extended</filename>
351 tarball that contains additional tools, the equivalent of <filename>buildtools-essential</filename>.
352 </para>
353 <section id='installing-a-pre-built-buildtools-tarball-with-install-buildtools-script'>
354 <title>Installing a Pre-Built <filename>buildtools</filename> Tarball with <filename>install-buildtools</filename> script</title>
355
356 <para>
357 The <filename>install-buildtools</filename> script is the easiest
358 of the three methods by which you can get these tools. It downloads
359 a pre-built buildtools installer and automatically installs the tools
360 for you:
361 <orderedlist>
362 <listitem><para>
363 Execute the <filename>install-buildtools</filename> script.
364 Here is an example:
365 <literallayout class='monospaced'>
366 $ cd poky
367 $ script/install-buildtools --without-extended-buildtools \
368 --base-url &YOCTO_DL_URL;/releases/yocto \
369 --release yocto-&DISTRO; \
370 --installer-version &DISTRO;
371 </literallayout>
372 <para>
373 During execution, the buildtools tarball will be downloaded,
374 the checksum of the download will be verified, the installer
375 will be run for you, and some basic checks will be run to
376 to make sure the installation is functional.
377 </para>
378 <para>
379 To avoid the need of <filename>sudo</filename> privileges,
380 the <filename>install-buildtools</filename> script will
381 by default tell the installer to install in:
382 <literallayout class='monospaced'>
383 <replaceable>/path/to/</replaceable>poky/buildtools
384 </literallayout>
385 </para>
386 <para>
387 If your host development system needs the additional tools
388 provided in the <filename>buildtools-extended</filename>
389 tarball, you can instead execute the
390 <filename>install-buildtools</filename> script with the
391 default parameters:
392 <literallayout class='monospaced'>
393 $ cd poky
394 $ script/install-buildtools
395 </literallayout>
396 </para>
397 </para></listitem>
398 <listitem><para>
399 Source the tools environment setup script by using a
400 command like the following:
401 <literallayout class='monospaced'>
402 $ source <replaceable>/path/to/</replaceable>poky/buildtools/environment-setup-x86_64-pokysdk-linux
403 </literallayout>
404 Of course, you need to supply your installation directory and be
405 sure to use the right file (i.e. i586 or x86_64).
406 </para>
407 <para>
408 After you have sourced the setup script,
409 the tools are added to <filename>PATH</filename>
410 and any other environment variables required to run the
411 tools are initialized.
412 The results are working versions versions of Git, tar,
413 Python and <filename>chrpath</filename>. And in the case of
414 the <filename>buildtools-extended</filename> tarball, additional
415 working versions of tools including <filename>gcc</filename>,
416 <filename>make</filename> and the other tools included in
417 <filename>packagegroup-core-buildessential</filename>.
418 </para></listitem>
419 </orderedlist>
420 </para>
421 </section>
422
340 <section id='downloading-a-pre-built-buildtools-tarball'> 423 <section id='downloading-a-pre-built-buildtools-tarball'>
341 <title>Downloading a Pre-Built <filename>buildtools</filename> Tarball</title> 424 <title>Downloading a Pre-Built <filename>buildtools</filename> Tarball</title>
342 425
@@ -346,14 +429,18 @@
346 <orderedlist> 429 <orderedlist>
347 <listitem><para> 430 <listitem><para>
348 Locate and download the <filename>*.sh</filename> at 431 Locate and download the <filename>*.sh</filename> at
349 <ulink url='&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;/buildtools/'></ulink>. 432 <ulink url='&YOCTO_RELEASE_DL_URL;/buildtools/'></ulink>.
350 </para></listitem> 433 </para></listitem>
351 <listitem><para> 434 <listitem><para>
352 Execute the installation script. 435 Execute the installation script.
353 Here is an example: 436 Here is an example for the traditional installer:
354 <literallayout class='monospaced'> 437 <literallayout class='monospaced'>
355 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh 438 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
356 </literallayout> 439 </literallayout>
440 Here is an example for the extended installer:
441 <literallayout class='monospaced'>
442 $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh
443 </literallayout>
357 During execution, a prompt appears that allows you to 444 During execution, a prompt appears that allows you to
358 choose the installation directory. 445 choose the installation directory.
359 For example, you could choose the following: 446 For example, you could choose the following:
@@ -376,7 +463,11 @@
376 and any other environment variables required to run the 463 and any other environment variables required to run the
377 tools are initialized. 464 tools are initialized.
378 The results are working versions versions of Git, tar, 465 The results are working versions versions of Git, tar,
379 Python and <filename>chrpath</filename>. 466 Python and <filename>chrpath</filename>. And in the case of
467 the <filename>buildtools-extended</filename> tarball, additional
468 working versions of tools including <filename>gcc</filename>,
469 <filename>make</filename> and the other tools included in
470 <filename>packagegroup-core-buildessential</filename>.
380 </para></listitem> 471 </para></listitem>
381 </orderedlist> 472 </orderedlist>
382 </para> 473 </para>
@@ -392,7 +483,7 @@
392 <filename>.sh</filename> file and then 483 <filename>.sh</filename> file and then
393 take steps to transfer and run it on a 484 take steps to transfer and run it on a
394 machine that does not meet the minimal Git, tar, and Python 485 machine that does not meet the minimal Git, tar, and Python
395 requirements. 486 (or gcc) requirements.
396 </para> 487 </para>
397 488
398 <para> 489 <para>
@@ -410,6 +501,10 @@
410 <literallayout class='monospaced'> 501 <literallayout class='monospaced'>
411 $ bitbake buildtools-tarball 502 $ bitbake buildtools-tarball
412 </literallayout> 503 </literallayout>
504 or run the BitBake command to build the extended tarball:
505 <literallayout class='monospaced'>
506 $ bitbake buildtools-extended-tarball
507 </literallayout>
413 <note> 508 <note>
414 The 509 The
415 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link> 510 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>
@@ -423,21 +518,25 @@
423 subdirectory of the 518 subdirectory of the
424 <link linkend='build-directory'>Build Directory</link>. 519 <link linkend='build-directory'>Build Directory</link>.
425 The installer file has the string "buildtools" 520 The installer file has the string "buildtools"
426 in the name. 521 (or "buildtools-extended") in the name.
427 </para></listitem> 522 </para></listitem>
428 <listitem><para> 523 <listitem><para>
429 Transfer the <filename>.sh</filename> file from the 524 Transfer the <filename>.sh</filename> file from the
430 build host to the machine that does not meet the 525 build host to the machine that does not meet the
431 Git, tar, or Python requirements. 526 Git, tar, or Python (or gcc) requirements.
432 </para></listitem> 527 </para></listitem>
433 <listitem><para> 528 <listitem><para>
434 On the machine that does not meet the requirements, 529 On the machine that does not meet the requirements,
435 run the <filename>.sh</filename> file 530 run the <filename>.sh</filename> file
436 to install the tools. 531 to install the tools.
437 Here is an example: 532 Here is an example for the traditional installer:
438 <literallayout class='monospaced'> 533 <literallayout class='monospaced'>
439 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh 534 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
440 </literallayout> 535 </literallayout>
536 Here is an example for the extended installer:
537 <literallayout class='monospaced'>
538 $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh
539 </literallayout>
441 During execution, a prompt appears that allows you to 540 During execution, a prompt appears that allows you to
442 choose the installation directory. 541 choose the installation directory.
443 For example, you could choose the following: 542 For example, you could choose the following:
@@ -449,10 +548,10 @@
449 Source the tools environment setup script by using a 548 Source the tools environment setup script by using a
450 command like the following: 549 command like the following:
451 <literallayout class='monospaced'> 550 <literallayout class='monospaced'>
452 $ source /home/<replaceable>your_username</replaceable>/buildtools/environment-setup-i586-poky-linux 551 $ source /home/<replaceable>your_username</replaceable>/buildtools/environment-setup-x86_64-poky-linux
453 </literallayout> 552 </literallayout>
454 Of course, you need to supply your installation directory and be 553 Of course, you need to supply your installation directory and be
455 sure to use the right file (i.e. i585 or x86-64). 554 sure to use the right file (i.e. i586 or x86_64).
456 </para> 555 </para>
457 <para> 556 <para>
458 After you have sourced the setup script, 557 After you have sourced the setup script,
@@ -460,7 +559,11 @@
460 and any other environment variables required to run the 559 and any other environment variables required to run the
461 tools are initialized. 560 tools are initialized.
462 The results are working versions versions of Git, tar, 561 The results are working versions versions of Git, tar,
463 Python and <filename>chrpath</filename>. 562 Python and <filename>chrpath</filename>. And in the case of
563 the <filename>buildtools-extended</filename> tarball, additional
564 working versions of tools including <filename>gcc</filename>,
565 <filename>make</filename> and the other tools included in
566 <filename>packagegroup-core-buildessential</filename>.
464 </para></listitem> 567 </para></listitem>
465 </orderedlist> 568 </orderedlist>
466 </para> 569 </para>