diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-12-14 09:36:00 +0100 |
|---|---|---|
| committer | Steve Sakoman <steve@sakoman.com> | 2024-03-01 05:19:55 -1000 |
| commit | e0c348b64473a66bdd13da4facbfd17700899a9d (patch) | |
| tree | 868d83772a60ad59cc8737d459afbb8624ae871d | |
| parent | 9e5a9e6f945dae5c3d2e1932449d9494d903cbff (diff) | |
| download | poky-e0c348b64473a66bdd13da4facbfd17700899a9d.tar.gz | |
manuals: update references to buildtools
Also fix number of corresponding paragraphs
(From yocto-docs rev: 28ee2d91fe4dd0549940dc5df1ff1d59363fcc0f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
| -rw-r--r-- | documentation/brief-yoctoprojectqs/index.rst | 2 | ||||
| -rw-r--r-- | documentation/dev-manual/start.rst | 4 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-1.5.rst | 3 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-1.7.rst | 4 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-2.1.rst | 6 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-2.2.rst | 2 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.2.rst | 2 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.3.rst | 6 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.4.rst | 2 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-4.0.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/faq.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/system-requirements.rst | 87 | ||||
| -rw-r--r-- | documentation/ref-manual/terms.rst | 18 | ||||
| -rw-r--r-- | documentation/test-manual/understand-autobuilder.rst | 2 |
14 files changed, 78 insertions, 64 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 462c942961..9eff13f583 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst | |||
| @@ -75,7 +75,7 @@ following requirements: | |||
| 75 | If your build host does not meet any of these three listed version | 75 | If your build host does not meet any of these three listed version |
| 76 | requirements, you can take steps to prepare the system so that you | 76 | requirements, you can take steps to prepare the system so that you |
| 77 | can still use the Yocto Project. See the | 77 | can still use the Yocto Project. See the |
| 78 | :ref:`ref-manual/system-requirements:required git, tar, python and gcc versions` | 78 | :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` |
| 79 | section in the Yocto Project Reference Manual for information. | 79 | section in the Yocto Project Reference Manual for information. |
| 80 | 80 | ||
| 81 | Build Host Packages | 81 | Build Host Packages |
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 9dc9b855b3..834fb13088 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst | |||
| @@ -308,10 +308,12 @@ Project Build Host: | |||
| 308 | 308 | ||
| 309 | - gcc &MIN_GCC_VERSION; or greater. | 309 | - gcc &MIN_GCC_VERSION; or greater. |
| 310 | 310 | ||
| 311 | - GNU make &MIN_MAKE_VERSION; or greater | ||
| 312 | |||
| 311 | If your build host does not meet any of these listed version | 313 | If your build host does not meet any of these listed version |
| 312 | requirements, you can take steps to prepare the system so that you | 314 | requirements, you can take steps to prepare the system so that you |
| 313 | can still use the Yocto Project. See the | 315 | can still use the Yocto Project. See the |
| 314 | ":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" | 316 | ":ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions`" |
| 315 | section in the Yocto Project Reference Manual for information. | 317 | section in the Yocto Project Reference Manual for information. |
| 316 | 318 | ||
| 317 | 4. *Install Development Host Packages:* Required development host | 319 | 4. *Install Development Host Packages:* Required development host |
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst index 81a434d5b7..06334d6fc7 100644 --- a/documentation/migration-guides/migration-1.5.rst +++ b/documentation/migration-guides/migration-1.5.rst | |||
| @@ -26,8 +26,7 @@ provide packages for these, you can install and use the Buildtools | |||
| 26 | tarball, which provides an SDK-like environment containing them. | 26 | tarball, which provides an SDK-like environment containing them. |
| 27 | 27 | ||
| 28 | For more information on this requirement, see the | 28 | For more information on this requirement, see the |
| 29 | ":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" | 29 | ":ref:`system-requirements-buildtools`" section. |
| 30 | section. | ||
| 31 | 30 | ||
| 32 | .. _migration-1.5-atom-pc-bsp: | 31 | .. _migration-1.5-atom-pc-bsp: |
| 33 | 32 | ||
diff --git a/documentation/migration-guides/migration-1.7.rst b/documentation/migration-guides/migration-1.7.rst index d4af1277e9..73eb6d1b81 100644 --- a/documentation/migration-guides/migration-1.7.rst +++ b/documentation/migration-guides/migration-1.7.rst | |||
| @@ -30,8 +30,8 @@ version required on the | |||
| 30 | build host is now 1.7.8 because the ``--list`` option is now required by | 30 | build host is now 1.7.8 because the ``--list`` option is now required by |
| 31 | BitBake's Git fetcher. As always, if your host distribution does not | 31 | BitBake's Git fetcher. As always, if your host distribution does not |
| 32 | provide a version of Git that meets this requirement, you can use the | 32 | provide a version of Git that meets this requirement, you can use the |
| 33 | ``buildtools-tarball`` that does. See the | 33 | :term:`buildtools` tarball that does. See the |
| 34 | ":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" | 34 | ":ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions`" |
| 35 | section for more information. | 35 | section for more information. |
| 36 | 36 | ||
| 37 | .. _migration-1.7-autotools-class-changes: | 37 | .. _migration-1.7-autotools-class-changes: |
diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst index 6ef3adb443..54d359a67c 100644 --- a/documentation/migration-guides/migration-2.1.rst +++ b/documentation/migration-guides/migration-2.1.rst | |||
| @@ -356,9 +356,9 @@ These additional changes exist: | |||
| 356 | 356 | ||
| 357 | - The minimum Git version has been increased to 1.8.3.1. If your host | 357 | - The minimum Git version has been increased to 1.8.3.1. If your host |
| 358 | distribution does not provide a sufficiently recent version, you can | 358 | distribution does not provide a sufficiently recent version, you can |
| 359 | install the buildtools, which will provide it. See the | 359 | install the :term:`buildtools`, which will provide it. See the |
| 360 | :ref:`ref-manual/system-requirements:required git, tar, python and gcc versions` | 360 | :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` |
| 361 | section for more information on the buildtools tarball. | 361 | section for more information on the :term:`buildtools` tarball. |
| 362 | 362 | ||
| 363 | - The buggy and incomplete support for the RPM version 4 package | 363 | - The buggy and incomplete support for the RPM version 4 package |
| 364 | manager has been removed. The well-tested and maintained support for | 364 | manager has been removed. The well-tested and maintained support for |
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index 49cd9b9ae0..979b5aa0f9 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst | |||
| @@ -103,7 +103,7 @@ online package-manager support through SMART still require Python 2. | |||
| 103 | ``buildtools-tarball`` Includes Python 3 | 103 | ``buildtools-tarball`` Includes Python 3 |
| 104 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 104 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 105 | 105 | ||
| 106 | ``buildtools-tarball`` now includes Python 3. | 106 | The :term:`buildtools` tarball now includes Python 3. |
| 107 | 107 | ||
| 108 | .. _migration-2.2-uclibc-replaced-by-musl: | 108 | .. _migration-2.2-uclibc-replaced-by-musl: |
| 109 | 109 | ||
diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index d593effe97..40a917bfc7 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst | |||
| @@ -11,7 +11,7 @@ Minimum system requirements | |||
| 11 | 11 | ||
| 12 | ``gcc`` version 6.0 is now required at minimum on the build host. For older | 12 | ``gcc`` version 6.0 is now required at minimum on the build host. For older |
| 13 | host distributions where this is not available, you can use the | 13 | host distributions where this is not available, you can use the |
| 14 | ``buildtools-extended-tarball`` (easily installable using | 14 | :term:`buildtools-extended` tarball (easily installable using |
| 15 | ``scripts/install-buildtools``). | 15 | ``scripts/install-buildtools``). |
| 16 | 16 | ||
| 17 | 17 | ||
diff --git a/documentation/migration-guides/migration-3.3.rst b/documentation/migration-guides/migration-3.3.rst index 1eb494c286..b1b81d6839 100644 --- a/documentation/migration-guides/migration-3.3.rst +++ b/documentation/migration-guides/migration-3.3.rst | |||
| @@ -12,9 +12,9 @@ Minimum system requirements | |||
| 12 | 12 | ||
| 13 | You will now need at least Python 3.6 installed on your build host. Most recent | 13 | You will now need at least Python 3.6 installed on your build host. Most recent |
| 14 | distributions provide this, but should you be building on a distribution that | 14 | distributions provide this, but should you be building on a distribution that |
| 15 | does not have it, you can use the ``buildtools-tarball`` (easily installable | 15 | does not have it, you can use the :term:`buildtools` tarball (easily installable |
| 16 | using ``scripts/install-buildtools``) - see | 16 | using ``scripts/install-buildtools``) --- see |
| 17 | :ref:`ref-manual/system-requirements:required git, tar, python and gcc versions` | 17 | :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` |
| 18 | for details. | 18 | for details. |
| 19 | 19 | ||
| 20 | 20 | ||
diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index b184dde41e..0ef6c435ec 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst | |||
| @@ -93,7 +93,7 @@ The ``lz4c``, ``pzstd`` and ``zstd`` commands are now required to be | |||
| 93 | installed on the build host to support LZ4 and Zstandard compression | 93 | installed on the build host to support LZ4 and Zstandard compression |
| 94 | functionality. These are typically provided by ``lz4`` and ``zstd`` | 94 | functionality. These are typically provided by ``lz4`` and ``zstd`` |
| 95 | packages in most Linux distributions. Alternatively they are available | 95 | packages in most Linux distributions. Alternatively they are available |
| 96 | as part of ``buildtools-tarball`` if your distribution does not provide | 96 | as part of :term:`buildtools` tarball if your distribution does not provide |
| 97 | them. For more information see | 97 | them. For more information see |
| 98 | :ref:`ref-manual/system-requirements:required packages for the build host`. | 98 | :ref:`ref-manual/system-requirements:required packages for the build host`. |
| 99 | 99 | ||
diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst index 9e78fc709f..93576d4538 100644 --- a/documentation/migration-guides/migration-4.0.rst +++ b/documentation/migration-guides/migration-4.0.rst | |||
| @@ -189,7 +189,7 @@ Supported host distribution changes | |||
| 189 | 189 | ||
| 190 | - ``gcc`` version 7.5 is now required at minimum on the build host. For older | 190 | - ``gcc`` version 7.5 is now required at minimum on the build host. For older |
| 191 | host distributions where this is not available, you can use the | 191 | host distributions where this is not available, you can use the |
| 192 | ``buildtools-extended-tarball`` (easily installable using | 192 | :term:`buildtools-extended` tarball (easily installable using |
| 193 | ``scripts/install-buildtools``). | 193 | ``scripts/install-buildtools``). |
| 194 | 194 | ||
| 195 | :append/:prepend in combination with other operators | 195 | :append/:prepend in combination with other operators |
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 9fb60899c9..478fbb3a69 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
| @@ -22,7 +22,7 @@ Can I still use the Yocto Project? | |||
| 22 | **A:** You can get the required tools on your host development system a | 22 | **A:** You can get the required tools on your host development system a |
| 23 | couple different ways (i.e. building a tarball or downloading a | 23 | couple different ways (i.e. building a tarball or downloading a |
| 24 | tarball). See the | 24 | tarball). See the |
| 25 | ":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" | 25 | ":ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions`" |
| 26 | section for steps on how to update your build tools. | 26 | section for steps on how to update your build tools. |
| 27 | 27 | ||
| 28 | **Q:** How can you claim Poky / OpenEmbedded-Core is stable? | 28 | **Q:** How can you claim Poky / OpenEmbedded-Core is stable? |
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index e0b8400178..1a6f7647b6 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
| @@ -276,8 +276,10 @@ supported CentOS-8 Linux distribution: | |||
| 276 | $ sudo dnf install make python3-pip which | 276 | $ sudo dnf install make python3-pip which |
| 277 | &PIP3_HOST_PACKAGES_DOC; | 277 | &PIP3_HOST_PACKAGES_DOC; |
| 278 | 278 | ||
| 279 | Required Git, tar, Python and gcc Versions | 279 | .. _system-requirements-buildtools: |
| 280 | ========================================== | 280 | |
| 281 | Required Git, tar, Python, make and gcc Versions | ||
| 282 | ================================================ | ||
| 281 | 283 | ||
| 282 | In order to use the build system, your host development system must meet | 284 | In order to use the build system, your host development system must meet |
| 283 | the following version requirements for Git, tar, and Python: | 285 | the following version requirements for Git, tar, and Python: |
| @@ -288,10 +290,12 @@ the following version requirements for Git, tar, and Python: | |||
| 288 | 290 | ||
| 289 | - Python &MIN_PYTHON_VERSION; or greater | 291 | - Python &MIN_PYTHON_VERSION; or greater |
| 290 | 292 | ||
| 293 | - GNU make &MIN_MAKE_VERSION; or greater | ||
| 294 | |||
| 291 | If your host development system does not meet all these requirements, | 295 | If your host development system does not meet all these requirements, |
| 292 | you can resolve this by installing a ``buildtools`` tarball that | 296 | you can resolve this by installing a :term:`buildtools` tarball that |
| 293 | contains these tools. You can get the tarball one of two ways: download | 297 | contains these tools. You can either download a pre-built tarball or |
| 294 | a pre-built tarball or use BitBake to build the tarball. | 298 | use BitBake to build one. |
| 295 | 299 | ||
| 296 | In addition, your host development system must meet the following | 300 | In addition, your host development system must meet the following |
| 297 | version requirement for gcc: | 301 | version requirement for gcc: |
| @@ -299,26 +303,26 @@ version requirement for gcc: | |||
| 299 | - gcc &MIN_GCC_VERSION; or greater | 303 | - gcc &MIN_GCC_VERSION; or greater |
| 300 | 304 | ||
| 301 | If your host development system does not meet this requirement, you can | 305 | If your host development system does not meet this requirement, you can |
| 302 | resolve this by installing a ``buildtools-extended`` tarball that | 306 | resolve this by installing a :term:`buildtools-extended` tarball that |
| 303 | contains additional tools, the equivalent of the Debian/Ubuntu ``build-essential`` | 307 | contains additional tools, the equivalent of the Debian/Ubuntu ``build-essential`` |
| 304 | package. | 308 | package. |
| 305 | 309 | ||
| 306 | For systems with a broken make version (e.g. make 4.2.1 without patches) but | 310 | For systems with a broken make version (e.g. make 4.2.1 without patches) but |
| 307 | where the rest of the host tools are usable, you can use the ``buildtools-make`` | 311 | where the rest of the host tools are usable, you can use the :term:`buildtools-make` |
| 308 | tarball instead. | 312 | tarball instead. |
| 309 | 313 | ||
| 310 | In the sections that follow, three different methods will be described for | 314 | In the sections that follow, three different methods will be described for |
| 311 | installing the ``buildtools``, ``buildtools-extended`` or ``buildtools-make`` | 315 | installing the :term:`buildtools`, :term:`buildtools-extended` or :term:`buildtools-make` |
| 312 | toolset. | 316 | toolset. |
| 313 | 317 | ||
| 314 | Installing a Pre-Built ``buildtools`` Tarball with ``install-buildtools`` script | 318 | Installing a Pre-Built ``buildtools`` Tarball with ``install-buildtools`` script |
| 315 | -------------------------------------------------------------------------------- | 319 | -------------------------------------------------------------------------------- |
| 316 | 320 | ||
| 317 | The ``install-buildtools`` script is the easiest of the three methods by | 321 | The ``install-buildtools`` script is the easiest of the three methods by |
| 318 | which you can get these tools. It downloads a pre-built buildtools | 322 | which you can get these tools. It downloads a pre-built :term:`buildtools` |
| 319 | installer and automatically installs the tools for you: | 323 | installer and automatically installs the tools for you: |
| 320 | 324 | ||
| 321 | 1. Execute the ``install-buildtools`` script. Here is an example:: | 325 | #. Execute the ``install-buildtools`` script. Here is an example:: |
| 322 | 326 | ||
| 323 | $ cd poky | 327 | $ cd poky |
| 324 | $ scripts/install-buildtools \ | 328 | $ scripts/install-buildtools \ |
| @@ -327,7 +331,7 @@ installer and automatically installs the tools for you: | |||
| 327 | --release yocto-&DISTRO; \ | 331 | --release yocto-&DISTRO; \ |
| 328 | --installer-version &DISTRO; | 332 | --installer-version &DISTRO; |
| 329 | 333 | ||
| 330 | During execution, the buildtools tarball will be downloaded, the | 334 | During execution, the :term:`buildtools` tarball will be downloaded, the |
| 331 | checksum of the download will be verified, the installer will be run | 335 | checksum of the download will be verified, the installer will be run |
| 332 | for you, and some basic checks will be run to make sure the | 336 | for you, and some basic checks will be run to make sure the |
| 333 | installation is functional. | 337 | installation is functional. |
| @@ -338,7 +342,7 @@ installer and automatically installs the tools for you: | |||
| 338 | /path/to/poky/buildtools | 342 | /path/to/poky/buildtools |
| 339 | 343 | ||
| 340 | If your host development system needs the additional tools provided | 344 | If your host development system needs the additional tools provided |
| 341 | in the ``buildtools-extended`` tarball, you can instead execute the | 345 | in the :term:`buildtools-extended` tarball, you can instead execute the |
| 342 | ``install-buildtools`` script with the default parameters:: | 346 | ``install-buildtools`` script with the default parameters:: |
| 343 | 347 | ||
| 344 | $ cd poky | 348 | $ cd poky |
| @@ -346,24 +350,21 @@ installer and automatically installs the tools for you: | |||
| 346 | 350 | ||
| 347 | Alternatively if your host development system has a broken ``make`` | 351 | Alternatively if your host development system has a broken ``make`` |
| 348 | version such that you only need a known good version of ``make``, | 352 | version such that you only need a known good version of ``make``, |
| 349 | you can use the ``--make-only`` option: | 353 | you can use the ``--make-only`` option:: |
| 350 | 354 | ||
| 351 | $ cd poky | 355 | $ cd poky |
| 352 | $ scripts/install-buildtools --make-only | 356 | $ scripts/install-buildtools --make-only |
| 353 | 357 | ||
| 354 | 2. Source the tools environment setup script by using a command like the | 358 | #. Source the tools environment setup script by using a command like the |
| 355 | following:: | 359 | following:: |
| 356 | 360 | ||
| 357 | $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux | 361 | $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux |
| 358 | 362 | ||
| 359 | Of course, you need to supply your installation directory and be sure to | ||
| 360 | use the right file (i.e. i586 or x86_64). | ||
| 361 | |||
| 362 | After you have sourced the setup script, the tools are added to | 363 | After you have sourced the setup script, the tools are added to |
| 363 | ``PATH`` and any other environment variables required to run the | 364 | ``PATH`` and any other environment variables required to run the |
| 364 | tools are initialized. The results are working versions versions of | 365 | tools are initialized. The results are working versions versions of |
| 365 | Git, tar, Python and ``chrpath``. And in the case of the | 366 | Git, tar, Python and ``chrpath``. And in the case of the |
| 366 | ``buildtools-extended`` tarball, additional working versions of tools | 367 | :term:`buildtools-extended` tarball, additional working versions of tools |
| 367 | including ``gcc``, ``make`` and the other tools included in | 368 | including ``gcc``, ``make`` and the other tools included in |
| 368 | ``packagegroup-core-buildessential``. | 369 | ``packagegroup-core-buildessential``. |
| 369 | 370 | ||
| @@ -371,12 +372,14 @@ Downloading a Pre-Built ``buildtools`` Tarball | |||
| 371 | ---------------------------------------------- | 372 | ---------------------------------------------- |
| 372 | 373 | ||
| 373 | If you would prefer not to use the ``install-buildtools`` script, you can instead | 374 | If you would prefer not to use the ``install-buildtools`` script, you can instead |
| 374 | download and run a pre-built buildtools installer yourself with the following | 375 | download and run a pre-built :term:`buildtools` installer yourself with the following |
| 375 | steps: | 376 | steps: |
| 376 | 377 | ||
| 377 | 1. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/` | 378 | #. Go to :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/`, locate and |
| 379 | download the ``.sh`` file corresponding to your host architecture | ||
| 380 | and to :term:`buildtools`, :term:`buildtools-extended` or :term:`buildtools-make`. | ||
| 378 | 381 | ||
| 379 | 2. Execute the installation script. Here is an example for the | 382 | #. Execute the installation script. Here is an example for the |
| 380 | traditional installer:: | 383 | traditional installer:: |
| 381 | 384 | ||
| 382 | $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh | 385 | $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh |
| @@ -393,44 +396,40 @@ steps: | |||
| 393 | installation directory. For example, you could choose the following: | 396 | installation directory. For example, you could choose the following: |
| 394 | ``/home/your-username/buildtools`` | 397 | ``/home/your-username/buildtools`` |
| 395 | 398 | ||
| 396 | 3. Source the tools environment setup script by using a command like the | 399 | #. As instructed by the installer script, you will have to source the tools |
| 397 | following:: | 400 | environment setup script:: |
| 398 | 401 | ||
| 399 | $ source /home/your_username/buildtools/environment-setup-i586-poky-linux | 402 | $ source /home/your_username/buildtools/environment-setup-x86_64-pokysdk-linux |
| 400 | |||
| 401 | Of | ||
| 402 | course, you need to supply your installation directory and be sure to | ||
| 403 | use the right file (i.e. i585 or x86-64). | ||
| 404 | 403 | ||
| 405 | After you have sourced the setup script, the tools are added to | 404 | After you have sourced the setup script, the tools are added to |
| 406 | ``PATH`` and any other environment variables required to run the | 405 | ``PATH`` and any other environment variables required to run the |
| 407 | tools are initialized. The results are working versions versions of | 406 | tools are initialized. The results are working versions versions of |
| 408 | Git, tar, Python and ``chrpath``. And in the case of the | 407 | Git, tar, Python and ``chrpath``. And in the case of the |
| 409 | ``buildtools-extended`` tarball, additional working versions of tools | 408 | :term:`buildtools-extended` tarball, additional working versions of tools |
| 410 | including ``gcc``, ``make`` and the other tools included in | 409 | including ``gcc``, ``make`` and the other tools included in |
| 411 | ``packagegroup-core-buildessential``. | 410 | ``packagegroup-core-buildessential``. |
| 412 | 411 | ||
| 413 | Building Your Own ``buildtools`` Tarball | 412 | Building Your Own ``buildtools`` Tarball |
| 414 | ---------------------------------------- | 413 | ---------------------------------------- |
| 415 | 414 | ||
| 416 | Building and running your own buildtools installer applies only when you | 415 | Building and running your own :term:`buildtools` installer applies only when you |
| 417 | have a build host that can already run BitBake. In this case, you use | 416 | have a build host that can already run BitBake. In this case, you use |
| 418 | that machine to build the ``.sh`` file and then take steps to transfer | 417 | that machine to build the ``.sh`` file and then take steps to transfer |
| 419 | and run it on a machine that does not meet the minimal Git, tar, and | 418 | and run it on a machine that does not meet the minimal Git, tar, and |
| 420 | Python (or gcc) requirements. | 419 | Python (or gcc) requirements. |
| 421 | 420 | ||
| 422 | Here are the steps to take to build and run your own buildtools | 421 | Here are the steps to take to build and run your own :term:`buildtools` |
| 423 | installer: | 422 | installer: |
| 424 | 423 | ||
| 425 | 1. On the machine that is able to run BitBake, be sure you have set up | 424 | #. On the machine that is able to run BitBake, be sure you have set up |
| 426 | your build environment with the setup script | 425 | your build environment with the setup script |
| 427 | (:ref:`structure-core-script`). | 426 | (:ref:`structure-core-script`). |
| 428 | 427 | ||
| 429 | 2. Run the BitBake command to build the tarball:: | 428 | #. Run the BitBake command to build the tarball:: |
| 430 | 429 | ||
| 431 | $ bitbake buildtools-tarball | 430 | $ bitbake buildtools-tarball |
| 432 | 431 | ||
| 433 | or run the BitBake command to build the extended tarball:: | 432 | or to build the extended tarball:: |
| 434 | 433 | ||
| 435 | $ bitbake buildtools-extended-tarball | 434 | $ bitbake buildtools-extended-tarball |
| 436 | 435 | ||
| @@ -446,22 +445,21 @@ installer: | |||
| 446 | Once the build completes, you can find the ``.sh`` file that installs | 445 | Once the build completes, you can find the ``.sh`` file that installs |
| 447 | the tools in the ``tmp/deploy/sdk`` subdirectory of the | 446 | the tools in the ``tmp/deploy/sdk`` subdirectory of the |
| 448 | :term:`Build Directory`. The installer file has the string | 447 | :term:`Build Directory`. The installer file has the string |
| 449 | "buildtools" (or "buildtools-extended") in the name. | 448 | "buildtools" or "buildtools-extended" in the name. |
| 450 | 449 | ||
| 451 | 3. Transfer the ``.sh`` file from the build host to the machine that | 450 | #. Transfer the ``.sh`` file from the build host to the machine that |
| 452 | does not meet the Git, tar, or Python (or gcc) requirements. | 451 | does not meet the Git, tar, or Python (or gcc) requirements. |
| 453 | 452 | ||
| 454 | 4. On the machine that does not meet the requirements, run the ``.sh`` | 453 | #. On this machine, run the ``.sh`` file to install the tools. Here is an |
| 455 | file to install the tools. Here is an example for the traditional | 454 | example for the traditional installer:: |
| 456 | installer:: | ||
| 457 | 455 | ||
| 458 | $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh | 456 | $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh |
| 459 | 457 | ||
| 460 | Here is an example for the extended installer:: | 458 | For the extended installer:: |
| 461 | 459 | ||
| 462 | $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh | 460 | $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh |
| 463 | 461 | ||
| 464 | or for the make-only installer:: | 462 | And for the make-only installer:: |
| 465 | 463 | ||
| 466 | $ sh ~/Downloads/x86_64-buildtools-make-nativesdk-standalone-&DISTRO;.sh | 464 | $ sh ~/Downloads/x86_64-buildtools-make-nativesdk-standalone-&DISTRO;.sh |
| 467 | 465 | ||
| @@ -469,18 +467,15 @@ installer: | |||
| 469 | installation directory. For example, you could choose the following: | 467 | installation directory. For example, you could choose the following: |
| 470 | ``/home/your_username/buildtools`` | 468 | ``/home/your_username/buildtools`` |
| 471 | 469 | ||
| 472 | 5. Source the tools environment setup script by using a command like the | 470 | #. Source the tools environment setup script by using a command like the |
| 473 | following:: | 471 | following:: |
| 474 | 472 | ||
| 475 | $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux | 473 | $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux |
| 476 | 474 | ||
| 477 | Of course, you need to supply your installation directory and be sure to | ||
| 478 | use the right file (i.e. i586 or x86_64). | ||
| 479 | |||
| 480 | After you have sourced the setup script, the tools are added to | 475 | After you have sourced the setup script, the tools are added to |
| 481 | ``PATH`` and any other environment variables required to run the | 476 | ``PATH`` and any other environment variables required to run the |
| 482 | tools are initialized. The results are working versions versions of | 477 | tools are initialized. The results are working versions versions of |
| 483 | Git, tar, Python and ``chrpath``. And in the case of the | 478 | Git, tar, Python and ``chrpath``. And in the case of the |
| 484 | ``buildtools-extended`` tarball, additional working versions of tools | 479 | :term:`buildtools-extended` tarball, additional working versions of tools |
| 485 | including ``gcc``, ``make`` and the other tools included in | 480 | including ``gcc``, ``make`` and the other tools included in |
| 486 | ``packagegroup-core-buildessential``. | 481 | ``packagegroup-core-buildessential``. |
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index d602f7ea36..98ca677015 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst | |||
| @@ -109,6 +109,24 @@ universal, the list includes them just in case: | |||
| 109 | environment. The build system is sometimes referred to as the development | 109 | environment. The build system is sometimes referred to as the development |
| 110 | host. | 110 | host. |
| 111 | 111 | ||
| 112 | :term:`buildtools` | ||
| 113 | Build tools in binary form, providing required versions of development | ||
| 114 | tools (such as Git, GCC, Python and make), to run the OpenEmbedded build | ||
| 115 | system on a development host without such minimum versions. | ||
| 116 | |||
| 117 | See the ":ref:`system-requirements-buildtools`" paragraph in the | ||
| 118 | Reference Manual for details about downloading or building an archive | ||
| 119 | of such tools. | ||
| 120 | |||
| 121 | :term:`buildtools-extended` | ||
| 122 | A set of :term:`buildtools` binaries extended with additional development | ||
| 123 | tools, such as a required version of the GCC compiler to run the | ||
| 124 | OpenEmbedded build system. | ||
| 125 | |||
| 126 | :term:`buildtools-make` | ||
| 127 | A variant of :term:`buildtools`, just providing the required | ||
| 128 | version of ``make`` to run the OpenEmbedded build system. | ||
| 129 | |||
| 112 | :term:`Classes` | 130 | :term:`Classes` |
| 113 | Files that provide for logic encapsulation and inheritance so that | 131 | Files that provide for logic encapsulation and inheritance so that |
| 114 | commonly used patterns can be defined once and then easily used in | 132 | commonly used patterns can be defined once and then easily used in |
diff --git a/documentation/test-manual/understand-autobuilder.rst b/documentation/test-manual/understand-autobuilder.rst index 11e2ceb12f..837109ad7d 100644 --- a/documentation/test-manual/understand-autobuilder.rst +++ b/documentation/test-manual/understand-autobuilder.rst | |||
| @@ -205,7 +205,7 @@ The ``scripts/run-config`` execution is where most of the work within | |||
| 205 | the Autobuilder happens. It runs through a number of steps; the first | 205 | the Autobuilder happens. It runs through a number of steps; the first |
| 206 | are general setup steps that are run once and include: | 206 | are general setup steps that are run once and include: |
| 207 | 207 | ||
| 208 | #. Set up any ``buildtools-tarball`` if configured. | 208 | #. Set up any :term:`buildtools` tarball if configured. |
| 209 | 209 | ||
| 210 | <<<<<<< HEAD | 210 | <<<<<<< HEAD |
| 211 | #. Call "buildhistory-init" if buildhistory is configured. | 211 | #. Call "buildhistory-init" if buildhistory is configured. |
