blob: 91ed6d8d6d53fa780cbd122b12c0f99fbcf044e7 [file] [log] [blame]
Andrew Geisslerf0343792020-11-18 10:42:21 -06001.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
Andrew Geisslerc9f78652020-09-18 14:11:35 -05002
3*******************
4System Requirements
5*******************
6
Andrew Geissler5199d832021-09-24 16:47:35 -05007Welcome to the Yocto Project Reference Manual. This manual provides
Andrew Geisslerc9f78652020-09-18 14:11:35 -05008reference information for the current release of the Yocto Project, and
9is most effectively used after you have an understanding of the basics
10of the Yocto Project. The manual is neither meant to be read as a
11starting point to the Yocto Project, nor read from start to finish.
12Rather, use this manual to find variable definitions, class
13descriptions, and so forth as needed during the course of using the
14Yocto Project.
15
16For introductory information on the Yocto Project, see the
17:yocto_home:`Yocto Project Website <>` and the
Andrew Geissler09209ee2020-12-13 08:44:15 -060018":ref:`overview-manual/development-environment:the yocto project development environment`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -050019chapter in the Yocto Project Overview and Concepts Manual.
20
21If you want to use the Yocto Project to quickly build an image without
22having to understand concepts, work through the
Andrew Geissler09209ee2020-12-13 08:44:15 -060023:doc:`/brief-yoctoprojectqs/index` document. You can find "how-to"
24information in the :doc:`/dev-manual/index`. You can find Yocto Project overview
25and conceptual information in the :doc:`/overview-manual/index`.
Andrew Geisslerc9f78652020-09-18 14:11:35 -050026
27.. note::
28
29 For more information about the Yocto Project Documentation set, see
Andrew Geissler4c19ea12020-10-27 13:52:24 -050030 the :ref:`ref-manual/resources:links and related documentation` section.
Andrew Geisslerc9f78652020-09-18 14:11:35 -050031
Patrick Williams8e7b46e2023-05-01 14:19:06 -050032Minimum Free Disk Space
33=======================
34
35To build an image such as ``core-image-sato`` for the ``qemux86-64`` machine,
36you need a system with at least &MIN_DISK_SPACE; Gbytes of free disk space.
37However, much more disk space will be necessary to build more complex images,
38to run multiple builds and to cache build artifacts, improving build efficiency.
39
40If you have a shortage of disk space, see the ":doc:`/dev-manual/disk-space`"
41section of the Development Tasks Manual.
42
43Minimum System RAM
44==================
45
46You will manage to build an image such as ``core-image-sato`` for the
47``qemux86-64`` machine with as little as &MIN_RAM; Gbytes of RAM on an old
48system with 4 CPU cores, but your builds will be much faster on a system with
49as much RAM and as many CPU cores as possible.
50
51.. _system-requirements-supported-distros:
Andrew Geisslerc9f78652020-09-18 14:11:35 -050052
53Supported Linux Distributions
54=============================
55
Andrew Geissler517393d2023-01-13 08:55:19 -060056Currently, the Yocto Project is supported on the following distributions:
Andrew Geisslerc9f78652020-09-18 14:11:35 -050057
Andrew Geisslerc9f78652020-09-18 14:11:35 -050058- Ubuntu 18.04 (LTS)
59
William A. Kennington IIIac69b482021-06-02 12:28:27 -070060- Ubuntu 20.04 (LTS)
Andrew Geisslerc9f78652020-09-18 14:11:35 -050061
Patrick Williams2194f502022-10-16 14:26:09 -050062- Ubuntu 22.04 (LTS)
63
Andrew Geissler6aa7eec2023-03-03 12:41:14 -060064- Fedora 36
Andrew Geisslerc9f78652020-09-18 14:11:35 -050065
Andrew Geissler6aa7eec2023-03-03 12:41:14 -060066- Fedora 37
Andrew Geissler9aee5002022-03-30 16:27:02 +000067
Andrew Geissler6aa7eec2023-03-03 12:41:14 -060068- AlmaLinux 8.7
Andrew Geisslerc9f78652020-09-18 14:11:35 -050069
Andrew Geissler6aa7eec2023-03-03 12:41:14 -060070- AlmaLinux 9.1
Andrew Geisslerc9f78652020-09-18 14:11:35 -050071
Andrew Geissler595f6302022-01-24 19:11:47 +000072- Debian GNU/Linux 11.x (Bullseye)
Andrew Geisslerc9f78652020-09-18 14:11:35 -050073
Andrew Geissler9aee5002022-03-30 16:27:02 +000074- OpenSUSE Leap 15.3
Andrew Geisslerc9f78652020-09-18 14:11:35 -050075
Andrew Geissler6aa7eec2023-03-03 12:41:14 -060076- OpenSUSE Leap 15.4
77
Andrew Geisslerc9f78652020-09-18 14:11:35 -050078.. note::
79
80 - While the Yocto Project Team attempts to ensure all Yocto Project
81 releases are one hundred percent compatible with each officially
William A. Kennington IIIac69b482021-06-02 12:28:27 -070082 supported Linux distribution, you may still encounter problems
83 that happen only with a specific distribution.
Andrew Geisslerc9f78652020-09-18 14:11:35 -050084
85 - Yocto Project releases are tested against the stable Linux
86 distributions in the above list. The Yocto Project should work
87 on other distributions but validation is not performed against
88 them.
89
90 - In particular, the Yocto Project does not support and currently
91 has no plans to support rolling-releases or development
92 distributions due to their constantly changing nature. We welcome
93 patches and bug reports, but keep in mind that our priority is on
Andrew Geissler517393d2023-01-13 08:55:19 -060094 the supported platforms listed above.
95
96 - If your Linux distribution is not in the above list, we recommend to
97 get the :term:`buildtools` or :term:`buildtools-extended` tarballs
98 containing the host tools required by your Yocto Project release,
99 typically by running ``scripts/install-buildtools`` as explained in
100 the ":ref:`system-requirements-buildtools`" section.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500101
102 - You may use Windows Subsystem For Linux v2 to set up a build host
Patrick Williams2390b1b2022-11-03 13:47:49 -0500103 using Windows 10 or later, or Windows Server 2019 or later, but validation
104 is not performed against build hosts using WSL 2.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500105
Patrick Williams2390b1b2022-11-03 13:47:49 -0500106 See the
107 :ref:`dev-manual/start:setting up to use windows subsystem for linux (wsl 2)`
108 section in the Yocto Project Development Tasks Manual for more information.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500109
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500110 - If you encounter problems, please go to :yocto_bugs:`Yocto Project
111 Bugzilla <>` and submit a bug. We are
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500112 interested in hearing about your experience. For information on
113 how to submit a bug, see the Yocto Project
Andrew Geissler09209ee2020-12-13 08:44:15 -0600114 :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
Andrew Geissler517393d2023-01-13 08:55:19 -0600115 and the ":ref:`dev-manual/changes:submitting a defect against the yocto project`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500116 section in the Yocto Project Development Tasks Manual.
117
118
119Required Packages for the Build Host
120====================================
121
122The list of packages you need on the host development system can be
123large when covering all build scenarios using the Yocto Project. This
124section describes required packages according to Linux distribution and
125function.
126
127.. _ubuntu-packages:
128
129Ubuntu and Debian
130-----------------
131
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500132Here are the packages needed to build an image on a headless system
133with a supported Ubuntu or Debian Linux distribution::
134
135 $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500136
137.. note::
138
139 - If your build system has the ``oss4-dev`` package installed, you
140 might experience QEMU build failures due to the package installing
141 its own custom ``/usr/include/linux/soundcard.h`` on the Debian
William A. Kennington IIIac69b482021-06-02 12:28:27 -0700142 system. If you run into this situation, try either of these solutions::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500143
Andrew Geisslereff27472021-10-29 15:35:00 -0500144 $ sudo apt build-dep qemu
145 $ sudo apt remove oss4-dev
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500146
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500147Here are the packages needed to build Project documentation manuals::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500148
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500149 $ sudo apt install make python3-pip inkscape texlive-latex-extra
150 &PIP3_HOST_PACKAGES_DOC;
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500151
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500152Fedora Packages
153---------------
154
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500155Here are the packages needed to build an image on a headless system
156with a supported Fedora Linux distribution::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500157
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500158 $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL;
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500159
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500160Here are the packages needed to build Project documentation manuals::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500161
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500162 $ sudo dnf install make python3-pip which inkscape texlive-fncychap
163 &PIP3_HOST_PACKAGES_DOC;
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500164
165openSUSE Packages
166-----------------
167
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500168Here are the packages needed to build an image on a headless system
169with a supported openSUSE distribution::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500170
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500171 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500172
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500173Here are the packages needed to build Project documentation manuals::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500174
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500175 $ sudo zypper install make python3-pip which inkscape texlive-fncychap
176 &PIP3_HOST_PACKAGES_DOC;
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500177
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500178
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500179AlmaLinux Packages
180------------------
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500181
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500182Here are the packages needed to build an image on a headless system
183with a supported AlmaLinux distribution::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500184
Andrew Geissler028142b2023-05-05 11:29:21 -0500185 $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL;
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500186
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500187.. note::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500188
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500189 - Extra Packages for Enterprise Linux (i.e. ``epel-release``) is
190 a collection of packages from Fedora built on RHEL/CentOS for
191 easy installation of packages not included in enterprise Linux
192 by default. You need to install these packages separately.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500193
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500194 - The ``PowerTools/CRB`` repo provides additional packages such as
195 ``rpcgen`` and ``texinfo``.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500196
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500197 - The ``makecache`` command consumes additional Metadata from
198 ``epel-release``.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500199
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500200Here are the packages needed to build Project documentation manuals::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500201
Andrew Geisslerfc113ea2023-03-31 09:59:46 -0500202 $ sudo dnf install make python3-pip which inkscape texlive-fncychap
203 &PIP3_HOST_PACKAGES_DOC;
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500204
Andrew Geissler517393d2023-01-13 08:55:19 -0600205.. _system-requirements-buildtools:
206
Andrew Geissler615f2f12022-07-15 14:00:58 -0500207Required Git, tar, Python, make and gcc Versions
208================================================
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500209
210In order to use the build system, your host development system must meet
211the following version requirements for Git, tar, and Python:
212
Andrew Geissler3b8a17c2021-04-15 15:55:55 -0500213- Git &MIN_GIT_VERSION; or greater
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500214
Andrew Geissler3b8a17c2021-04-15 15:55:55 -0500215- tar &MIN_TAR_VERSION; or greater
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500216
Andrew Geissler3b8a17c2021-04-15 15:55:55 -0500217- Python &MIN_PYTHON_VERSION; or greater
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500218
Andrew Geissler615f2f12022-07-15 14:00:58 -0500219- GNU make &MIN_MAKE_VERSION; or greater
220
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500221If your host development system does not meet all these requirements,
Andrew Geissler517393d2023-01-13 08:55:19 -0600222you can resolve this by installing a :term:`buildtools` tarball that
223contains these tools. You can either download a pre-built tarball or
224use BitBake to build one.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500225
226In addition, your host development system must meet the following
227version requirement for gcc:
228
Andrew Geissler3b8a17c2021-04-15 15:55:55 -0500229- gcc &MIN_GCC_VERSION; or greater
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500230
231If your host development system does not meet this requirement, you can
Andrew Geissler517393d2023-01-13 08:55:19 -0600232resolve this by installing a :term:`buildtools-extended` tarball that
Andrew Geissler3b8a17c2021-04-15 15:55:55 -0500233contains additional tools, the equivalent of the Debian/Ubuntu ``build-essential``
234package.
235
Patrick Williams2390b1b2022-11-03 13:47:49 -0500236For systems with a broken make version (e.g. make 4.2.1 without patches) but
Andrew Geissler517393d2023-01-13 08:55:19 -0600237where the rest of the host tools are usable, you can use the :term:`buildtools-make`
Patrick Williams2390b1b2022-11-03 13:47:49 -0500238tarball instead.
239
Andrew Geissler3b8a17c2021-04-15 15:55:55 -0500240In the sections that follow, three different methods will be described for
Andrew Geissler517393d2023-01-13 08:55:19 -0600241installing the :term:`buildtools`, :term:`buildtools-extended` or :term:`buildtools-make`
Patrick Williams2390b1b2022-11-03 13:47:49 -0500242toolset.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500243
244Installing a Pre-Built ``buildtools`` Tarball with ``install-buildtools`` script
245--------------------------------------------------------------------------------
246
247The ``install-buildtools`` script is the easiest of the three methods by
Andrew Geissler517393d2023-01-13 08:55:19 -0600248which you can get these tools. It downloads a pre-built :term:`buildtools`
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500249installer and automatically installs the tools for you:
250
Andrew Geissler517393d2023-01-13 08:55:19 -0600251#. Execute the ``install-buildtools`` script. Here is an example::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500252
253 $ cd poky
Andrew Geissler5199d832021-09-24 16:47:35 -0500254 $ scripts/install-buildtools \
255 --without-extended-buildtools \
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500256 --base-url &YOCTO_DL_URL;/releases/yocto \
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500257 --release yocto-&DISTRO; \
258 --installer-version &DISTRO;
259
Andrew Geissler517393d2023-01-13 08:55:19 -0600260 During execution, the :term:`buildtools` tarball will be downloaded, the
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500261 checksum of the download will be verified, the installer will be run
Andrew Geissler3b8a17c2021-04-15 15:55:55 -0500262 for you, and some basic checks will be run to make sure the
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500263 installation is functional.
264
265 To avoid the need of ``sudo`` privileges, the ``install-buildtools``
Andrew Geisslerc926e172021-05-07 16:11:35 -0500266 script will by default tell the installer to install in::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500267
268 /path/to/poky/buildtools
269
270 If your host development system needs the additional tools provided
Andrew Geissler517393d2023-01-13 08:55:19 -0600271 in the :term:`buildtools-extended` tarball, you can instead execute the
Andrew Geisslerc926e172021-05-07 16:11:35 -0500272 ``install-buildtools`` script with the default parameters::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500273
274 $ cd poky
275 $ scripts/install-buildtools
276
Patrick Williams2390b1b2022-11-03 13:47:49 -0500277 Alternatively if your host development system has a broken ``make``
278 version such that you only need a known good version of ``make``,
Andrew Geissler517393d2023-01-13 08:55:19 -0600279 you can use the ``--make-only`` option::
Patrick Williams2390b1b2022-11-03 13:47:49 -0500280
281 $ cd poky
282 $ scripts/install-buildtools --make-only
283
Andrew Geissler517393d2023-01-13 08:55:19 -0600284#. Source the tools environment setup script by using a command like the
Andrew Geisslerc926e172021-05-07 16:11:35 -0500285 following::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500286
287 $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux
288
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500289 After you have sourced the setup script, the tools are added to
290 ``PATH`` and any other environment variables required to run the
291 tools are initialized. The results are working versions versions of
292 Git, tar, Python and ``chrpath``. And in the case of the
Andrew Geissler517393d2023-01-13 08:55:19 -0600293 :term:`buildtools-extended` tarball, additional working versions of tools
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500294 including ``gcc``, ``make`` and the other tools included in
295 ``packagegroup-core-buildessential``.
296
297Downloading a Pre-Built ``buildtools`` Tarball
298----------------------------------------------
299
Andrew Geissler3b8a17c2021-04-15 15:55:55 -0500300If you would prefer not to use the ``install-buildtools`` script, you can instead
Andrew Geissler517393d2023-01-13 08:55:19 -0600301download and run a pre-built :term:`buildtools` installer yourself with the following
Andrew Geissler3b8a17c2021-04-15 15:55:55 -0500302steps:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500303
Andrew Geissler517393d2023-01-13 08:55:19 -0600304#. Go to :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/`, locate and
305 download the ``.sh`` file corresponding to your host architecture
306 and to :term:`buildtools`, :term:`buildtools-extended` or :term:`buildtools-make`.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500307
Andrew Geissler517393d2023-01-13 08:55:19 -0600308#. Execute the installation script. Here is an example for the
Andrew Geisslerc926e172021-05-07 16:11:35 -0500309 traditional installer::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500310
Andrew Geisslerd1e89492021-02-12 15:35:20 -0600311 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500312
Andrew Geisslerc926e172021-05-07 16:11:35 -0500313 Here is an example for the extended installer::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500314
Andrew Geisslerd1e89492021-02-12 15:35:20 -0600315 $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500316
Patrick Williams2390b1b2022-11-03 13:47:49 -0500317 An example for the make-only installer::
318
319 $ sh ~/Downloads/x86_64-buildtools-make-nativesdk-standalone-&DISTRO;.sh
320
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500321 During execution, a prompt appears that allows you to choose the
322 installation directory. For example, you could choose the following:
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500323 ``/home/your-username/buildtools``
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500324
Andrew Geissler517393d2023-01-13 08:55:19 -0600325#. As instructed by the installer script, you will have to source the tools
326 environment setup script::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500327
Andrew Geissler517393d2023-01-13 08:55:19 -0600328 $ source /home/your_username/buildtools/environment-setup-x86_64-pokysdk-linux
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500329
330 After you have sourced the setup script, the tools are added to
331 ``PATH`` and any other environment variables required to run the
332 tools are initialized. The results are working versions versions of
333 Git, tar, Python and ``chrpath``. And in the case of the
Andrew Geissler517393d2023-01-13 08:55:19 -0600334 :term:`buildtools-extended` tarball, additional working versions of tools
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500335 including ``gcc``, ``make`` and the other tools included in
336 ``packagegroup-core-buildessential``.
337
338Building Your Own ``buildtools`` Tarball
339----------------------------------------
340
Andrew Geissler517393d2023-01-13 08:55:19 -0600341Building and running your own :term:`buildtools` installer applies only when you
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500342have a build host that can already run BitBake. In this case, you use
343that machine to build the ``.sh`` file and then take steps to transfer
344and run it on a machine that does not meet the minimal Git, tar, and
345Python (or gcc) requirements.
346
Andrew Geissler517393d2023-01-13 08:55:19 -0600347Here are the steps to take to build and run your own :term:`buildtools`
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500348installer:
349
Andrew Geissler517393d2023-01-13 08:55:19 -0600350#. On the machine that is able to run BitBake, be sure you have set up
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500351 your build environment with the setup script
352 (:ref:`structure-core-script`).
353
Andrew Geissler517393d2023-01-13 08:55:19 -0600354#. Run the BitBake command to build the tarball::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500355
356 $ bitbake buildtools-tarball
357
Andrew Geissler517393d2023-01-13 08:55:19 -0600358 or to build the extended tarball::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500359
360 $ bitbake buildtools-extended-tarball
361
Patrick Williams2390b1b2022-11-03 13:47:49 -0500362 or to build the make-only tarball::
363
364 $ bitbake buildtools-make-tarball
365
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500366 .. note::
367
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500368 The :term:`SDKMACHINE` variable in your ``local.conf`` file determines
369 whether you build tools for a 32-bit or 64-bit system.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500370
371 Once the build completes, you can find the ``.sh`` file that installs
372 the tools in the ``tmp/deploy/sdk`` subdirectory of the
373 :term:`Build Directory`. The installer file has the string
Andrew Geissler517393d2023-01-13 08:55:19 -0600374 "buildtools" or "buildtools-extended" in the name.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500375
Andrew Geissler517393d2023-01-13 08:55:19 -0600376#. Transfer the ``.sh`` file from the build host to the machine that
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500377 does not meet the Git, tar, or Python (or gcc) requirements.
378
Andrew Geissler517393d2023-01-13 08:55:19 -0600379#. On this machine, run the ``.sh`` file to install the tools. Here is an
380 example for the traditional installer::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500381
382 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
383
Andrew Geissler517393d2023-01-13 08:55:19 -0600384 For the extended installer::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500385
386 $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh
387
Andrew Geissler517393d2023-01-13 08:55:19 -0600388 And for the make-only installer::
Patrick Williams2390b1b2022-11-03 13:47:49 -0500389
390 $ sh ~/Downloads/x86_64-buildtools-make-nativesdk-standalone-&DISTRO;.sh
391
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500392 During execution, a prompt appears that allows you to choose the
393 installation directory. For example, you could choose the following:
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500394 ``/home/your_username/buildtools``
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500395
Andrew Geissler517393d2023-01-13 08:55:19 -0600396#. Source the tools environment setup script by using a command like the
Andrew Geisslerc926e172021-05-07 16:11:35 -0500397 following::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500398
399 $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux
400
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500401 After you have sourced the setup script, the tools are added to
402 ``PATH`` and any other environment variables required to run the
403 tools are initialized. The results are working versions versions of
404 Git, tar, Python and ``chrpath``. And in the case of the
Andrew Geissler517393d2023-01-13 08:55:19 -0600405 :term:`buildtools-extended` tarball, additional working versions of tools
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500406 including ``gcc``, ``make`` and the other tools included in
407 ``packagegroup-core-buildessential``.