summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-12-13 19:47:52 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-12-18 10:41:21 +0000
commit4925cd416820ab2b48aaa780a053b6fa52d794e9 (patch)
treee0bf189e4bda135cb047c6f75189677c4505f659 /documentation
parent22e75ec79fdbbca6bd4643bd80066ae88451cce9 (diff)
downloadpoky-4925cd416820ab2b48aaa780a053b6fa52d794e9.tar.gz
ref-manual/system-requirements.rst: update buildtools instructions
- Stop mentioning the buildtools i586 environment setup file, no longer available. - Remove trivial or redundant instructions. (From yocto-docs rev: 589c7b22b8279ebc62a72106969fde2af92f8753) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/system-requirements.rst41
1 files changed, 17 insertions, 24 deletions
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 3f27c03e44..ebb6ca6470 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -191,6 +191,8 @@ supported AlmaLinux-8 Linux distribution:
191 $ sudo dnf install make python3-pip which inkscape texlive-fncychap 191 $ sudo dnf install make python3-pip which inkscape texlive-fncychap
192 &PIP3_HOST_PACKAGES_DOC; 192 &PIP3_HOST_PACKAGES_DOC;
193 193
194.. _system-requirements-buildtools:
195
194Required Git, tar, Python, make and gcc Versions 196Required Git, tar, Python, make and gcc Versions
195================================================ 197================================================
196 198
@@ -207,8 +209,8 @@ the following version requirements for Git, tar, and Python:
207 209
208If your host development system does not meet all these requirements, 210If your host development system does not meet all these requirements,
209you can resolve this by installing a ``buildtools`` tarball that 211you can resolve this by installing a ``buildtools`` tarball that
210contains these tools. You can get the tarball one of two ways: download 212contains these tools. You can either download a pre-built tarball or
211a pre-built tarball or use BitBake to build the tarball. 213use BitBake to build one.
212 214
213In addition, your host development system must meet the following 215In addition, your host development system must meet the following
214version requirement for gcc: 216version requirement for gcc:
@@ -263,7 +265,7 @@ installer and automatically installs the tools for you:
263 265
264 Alternatively if your host development system has a broken ``make`` 266 Alternatively if your host development system has a broken ``make``
265 version such that you only need a known good version of ``make``, 267 version such that you only need a known good version of ``make``,
266 you can use the ``--make-only`` option: 268 you can use the ``--make-only`` option::
267 269
268 $ cd poky 270 $ cd poky
269 $ scripts/install-buildtools --make-only 271 $ scripts/install-buildtools --make-only
@@ -273,9 +275,6 @@ installer and automatically installs the tools for you:
273 275
274 $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux 276 $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux
275 277
276 Of course, you need to supply your installation directory and be sure to
277 use the right file (i.e. i586 or x86_64).
278
279 After you have sourced the setup script, the tools are added to 278 After you have sourced the setup script, the tools are added to
280 ``PATH`` and any other environment variables required to run the 279 ``PATH`` and any other environment variables required to run the
281 tools are initialized. The results are working versions versions of 280 tools are initialized. The results are working versions versions of
@@ -291,7 +290,9 @@ If you would prefer not to use the ``install-buildtools`` script, you can instea
291download and run a pre-built buildtools installer yourself with the following 290download and run a pre-built buildtools installer yourself with the following
292steps: 291steps:
293 292
294#. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/` 293#. Go to :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/`, locate and
294 download the ``.sh`` file corresponding to your host architecture
295 and to ``buildtools``, ``buildtools-extended`` or ``buildtools-make``.
295 296
296#. Execute the installation script. Here is an example for the 297#. Execute the installation script. Here is an example for the
297 traditional installer:: 298 traditional installer::
@@ -310,14 +311,10 @@ steps:
310 installation directory. For example, you could choose the following: 311 installation directory. For example, you could choose the following:
311 ``/home/your-username/buildtools`` 312 ``/home/your-username/buildtools``
312 313
313#. Source the tools environment setup script by using a command like the 314#. As instructed by the installer script, you will have to source the tools
314 following:: 315 environment setup script::
315 316
316 $ source /home/your_username/buildtools/environment-setup-i586-poky-linux 317 $ source /home/your_username/buildtools/environment-setup-x86_64-pokysdk-linux
317
318 Of
319 course, you need to supply your installation directory and be sure to
320 use the right file (i.e. i585 or x86-64).
321 318
322 After you have sourced the setup script, the tools are added to 319 After you have sourced the setup script, the tools are added to
323 ``PATH`` and any other environment variables required to run the 320 ``PATH`` and any other environment variables required to run the
@@ -347,7 +344,7 @@ installer:
347 344
348 $ bitbake buildtools-tarball 345 $ bitbake buildtools-tarball
349 346
350 or run the BitBake command to build the extended tarball:: 347 or to build the extended tarball::
351 348
352 $ bitbake buildtools-extended-tarball 349 $ bitbake buildtools-extended-tarball
353 350
@@ -363,22 +360,21 @@ installer:
363 Once the build completes, you can find the ``.sh`` file that installs 360 Once the build completes, you can find the ``.sh`` file that installs
364 the tools in the ``tmp/deploy/sdk`` subdirectory of the 361 the tools in the ``tmp/deploy/sdk`` subdirectory of the
365 :term:`Build Directory`. The installer file has the string 362 :term:`Build Directory`. The installer file has the string
366 "buildtools" (or "buildtools-extended") in the name. 363 "buildtools" or "buildtools-extended" in the name.
367 364
368#. Transfer the ``.sh`` file from the build host to the machine that 365#. Transfer the ``.sh`` file from the build host to the machine that
369 does not meet the Git, tar, or Python (or gcc) requirements. 366 does not meet the Git, tar, or Python (or gcc) requirements.
370 367
371#. On the machine that does not meet the requirements, run the ``.sh`` 368#. On this machine, run the ``.sh`` file to install the tools. Here is an
372 file to install the tools. Here is an example for the traditional 369 example for the traditional installer::
373 installer::
374 370
375 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh 371 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
376 372
377 Here is an example for the extended installer:: 373 For the extended installer::
378 374
379 $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh 375 $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh
380 376
381 or for the make-only installer:: 377 And for the make-only installer::
382 378
383 $ sh ~/Downloads/x86_64-buildtools-make-nativesdk-standalone-&DISTRO;.sh 379 $ sh ~/Downloads/x86_64-buildtools-make-nativesdk-standalone-&DISTRO;.sh
384 380
@@ -391,9 +387,6 @@ installer:
391 387
392 $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux 388 $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux
393 389
394 Of course, you need to supply your installation directory and be sure to
395 use the right file (i.e. i586 or x86_64).
396
397 After you have sourced the setup script, the tools are added to 390 After you have sourced the setup script, the tools are added to
398 ``PATH`` and any other environment variables required to run the 391 ``PATH`` and any other environment variables required to run the
399 tools are initialized. The results are working versions versions of 392 tools are initialized. The results are working versions versions of