From 07aaa69d57290637d146ea26baf4aeeec7e10138 Mon Sep 17 00:00:00 2001 From: Tim Orling Date: Thu, 2 Apr 2020 17:55:55 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/faq.xml | 4 +- documentation/ref-manual/migration.xml | 6 +- .../ref-manual/ref-system-requirements.xml | 127 +++++++++++++++++++-- 3 files changed, 120 insertions(+), 17 deletions(-) diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml index 49ff86261d..d94cb32a86 100644 --- a/documentation/ref-manual/faq.xml +++ b/documentation/ref-manual/faq.xml @@ -33,7 +33,7 @@ My development system does not meet the required Git, tar, and Python versions. - In particular, I do not have Python 3.4.0 or greater. + In particular, I do not have Python 3.5.0 or greater. Can I still use the Yocto Project? @@ -43,7 +43,7 @@ system a couple different ways (i.e. building a tarball or downloading a tarball). See the - "Required Git, tar, and Python Versions" + "Required Git, tar, Python and gcc Versions" section for steps on how to update your build tools. diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 80a6acc951..03efc7be2f 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml @@ -680,7 +680,7 @@ For more information on this requirement, see the - "Required Git, tar, and Python Versions" + "Required Git, tar, Python and gcc Versions" section. @@ -1754,7 +1754,7 @@ Git that meets this requirement, you can use the buildtools-tarball that does. See the - "Required Git, tar, and Python Versions" + "Required Git, tar, Python and gcc Versions" section for more information. @@ -3215,7 +3215,7 @@ recent version, you can install the buildtools, which will provide it. See the - "Required Git, tar, and Python Versions" + "Required Git, tar, Python and gcc Versions" section for more information on the buildtools tarball. diff --git a/documentation/ref-manual/ref-system-requirements.xml b/documentation/ref-manual/ref-system-requirements.xml index 6153117f1b..2c019960f8 100644 --- a/documentation/ref-manual/ref-system-requirements.xml +++ b/documentation/ref-manual/ref-system-requirements.xml @@ -315,8 +315,8 @@ -
- Required Git, tar, and Python Versions +
+ Required Git, tar, Python and gcc Versions In order to use the build system, your host development system @@ -337,6 +337,89 @@ tarball or use BitBake to build the tarball. + + In addition, your host development system must meet the following + version requirement for gcc: + + gcc 5.0 or greater + + + + + If your host development system does not meet this requirement, + you can resolve this by installing a buildtools-extended + tarball that contains additional tools, the equivalent of buildtools-essential. + +
+ Installing a Pre-Built <filename>buildtools</filename> Tarball with <filename>install-buildtools</filename> script + + + The install-buildtools script is the easiest + of the three methods by which you can get these tools. It downloads + a pre-built buildtools installer and automatically installs the tools + for you: + + + Execute the install-buildtools script. + Here is an example: + + $ cd poky + $ script/install-buildtools --without-extended-buildtools \ + --base-url &YOCTO_DL_URL;/releases/yocto \ + --release yocto-&DISTRO; \ + --installer-version &DISTRO; + + + During execution, the buildtools tarball will be downloaded, + the checksum of the download will be verified, the installer + will be run for you, and some basic checks will be run to + to make sure the installation is functional. + + + To avoid the need of sudo privileges, + the install-buildtools script will + by default tell the installer to install in: + + /path/to/poky/buildtools + + + + If your host development system needs the additional tools + provided in the buildtools-extended + tarball, you can instead execute the + install-buildtools script with the + default parameters: + + $ cd poky + $ script/install-buildtools + + + + + Source the tools environment setup script by using a + command like the following: + + $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux + + Of course, you need to supply your installation directory and be + sure to use the right file (i.e. i586 or x86_64). + + + After you have sourced the setup script, + the tools are added to PATH + and any other environment variables required to run the + tools are initialized. + The results are working versions versions of Git, tar, + Python and chrpath. And in the case of + the buildtools-extended tarball, additional + working versions of tools including gcc, + make and the other tools included in + packagegroup-core-buildessential. + + + +
+
Downloading a Pre-Built <filename>buildtools</filename> Tarball @@ -346,13 +429,17 @@ Locate and download the *.sh at - . + . Execute the installation script. - Here is an example: + Here is an example for the traditional installer: $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh + + Here is an example for the extended installer: + + $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh During execution, a prompt appears that allows you to choose the installation directory. @@ -376,7 +463,11 @@ and any other environment variables required to run the tools are initialized. The results are working versions versions of Git, tar, - Python and chrpath. + Python and chrpath. And in the case of + the buildtools-extended tarball, additional + working versions of tools including gcc, + make and the other tools included in + packagegroup-core-buildessential. @@ -392,7 +483,7 @@ .sh file and then take steps to transfer and run it on a machine that does not meet the minimal Git, tar, and Python - requirements. + (or gcc) requirements. @@ -410,6 +501,10 @@ $ bitbake buildtools-tarball + or run the BitBake command to build the extended tarball: + + $ bitbake buildtools-extended-tarball + The SDKMACHINE @@ -423,21 +518,25 @@ subdirectory of the Build Directory. The installer file has the string "buildtools" - in the name. + (or "buildtools-extended") in the name. Transfer the .sh file from the build host to the machine that does not meet the - Git, tar, or Python requirements. + Git, tar, or Python (or gcc) requirements. On the machine that does not meet the requirements, run the .sh file to install the tools. - Here is an example: + Here is an example for the traditional installer: $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh + Here is an example for the extended installer: + + $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh + During execution, a prompt appears that allows you to choose the installation directory. For example, you could choose the following: @@ -449,10 +548,10 @@ Source the tools environment setup script by using a command like the following: - $ source /home/your_username/buildtools/environment-setup-i586-poky-linux + $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux Of course, you need to supply your installation directory and be - sure to use the right file (i.e. i585 or x86-64). + sure to use the right file (i.e. i586 or x86_64). After you have sourced the setup script, @@ -460,7 +559,11 @@ and any other environment variables required to run the tools are initialized. The results are working versions versions of Git, tar, - Python and chrpath. + Python and chrpath. And in the case of + the buildtools-extended tarball, additional + working versions of tools including gcc, + make and the other tools included in + packagegroup-core-buildessential. -- cgit v1.2.3-54-g00ecf