summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-system-requirements.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-system-requirements.rst')
-rw-r--r--documentation/ref-manual/ref-system-requirements.rst181
1 files changed, 120 insertions, 61 deletions
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst
index b82bed8a76..56218e4ebb 100644
--- a/documentation/ref-manual/ref-system-requirements.rst
+++ b/documentation/ref-manual/ref-system-requirements.rst
@@ -14,18 +14,15 @@ descriptions, and so forth as needed during the course of using the
14Yocto Project. 14Yocto Project.
15 15
16For introductory information on the Yocto Project, see the 16For introductory information on the Yocto Project, see the
17:yocto_home:`Yocto Project Website <>` and the "`Yocto Project 17:yocto_home:`Yocto Project Website <>` and the
18Development 18":ref:`overview-manual/overview-manual-development-environment:the yocto project development environment`"
19Environment <&YOCTO_DOCS_OM_URL;#overview-development-environment>`__"
20chapter in the Yocto Project Overview and Concepts Manual. 19chapter in the Yocto Project Overview and Concepts Manual.
21 20
22If you want to use the Yocto Project to quickly build an image without 21If you want to use the Yocto Project to quickly build an image without
23having to understand concepts, work through the `Yocto Project Quick 22having to understand concepts, work through the
24Build <&YOCTO_DOCS_BRIEF_URL;>`__ document. You can find "how-to" 23:doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. You can find "how-to"
25information in the `Yocto Project Development Tasks 24information in the :doc:`../dev-manual/dev-manual`. You can find Yocto Project overview
26Manual <&YOCTO_DOCS_DEV_URL;>`__. You can find Yocto Project overview 25and conceptual information in the :doc:`../overview-manual/overview-manual`.
27and conceptual information in the `Yocto Project Overview and Concepts
28Manual <&YOCTO_DOCS_OM_URL;>`__.
29 26
30.. note:: 27.. note::
31 28
@@ -95,12 +92,11 @@ distributions:
95 WSLv2, if you still decide to use WSL please upgrade to WSLv2. 92 WSLv2, if you still decide to use WSL please upgrade to WSLv2.
96 93
97 - If you encounter problems, please go to `Yocto Project 94 - If you encounter problems, please go to `Yocto Project
98 Bugzilla <&YOCTO_BUGZILLA_URL;>`__ and submit a bug. We are 95 Bugzilla <http://bugzilla.yoctoproject.org>`__ and submit a bug. We are
99 interested in hearing about your experience. For information on 96 interested in hearing about your experience. For information on
100 how to submit a bug, see the Yocto Project 97 how to submit a bug, see the Yocto Project
101 :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` 98 :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`
102 and the "`Submitting a Defect Against the Yocto 99 and the ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`"
103 Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__"
104 section in the Yocto Project Development Tasks Manual. 100 section in the Yocto Project Development Tasks Manual.
105 101
106 102
@@ -126,19 +122,28 @@ supported Ubuntu or Debian Linux distribution:
126 might experience QEMU build failures due to the package installing 122 might experience QEMU build failures due to the package installing
127 its own custom ``/usr/include/linux/soundcard.h`` on the Debian 123 its own custom ``/usr/include/linux/soundcard.h`` on the Debian
128 system. If you run into this situation, either of the following 124 system. If you run into this situation, either of the following
129 solutions exist: $ sudo apt-get build-dep qemu $ sudo apt-get 125 solutions exist:
130 remove oss4-dev 126 ::
127
128 $ sudo apt-get build-dep qemu
129 $ sudo apt-get remove oss4-dev
131 130
132 - For Debian-8, ``python3-git`` and ``pylint3`` are no longer 131 - For Debian-8, ``python3-git`` and ``pylint3`` are no longer
133 available via ``apt-get``. $ sudo pip3 install GitPython 132 available via ``apt-get``.
134 pylint==1.9.5 133 ::
134
135 $ sudo pip3 install GitPython pylint==1.9.5
135 136
136- *Essentials:* Packages needed to build an image on a headless system: 137- *Essentials:* Packages needed to build an image on a headless system:
137 $ sudo apt-get install UBUNTU_HOST_PACKAGES_ESSENTIAL 138 ::
139
140 $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
138 141
139- *Documentation:* Packages needed if you are going to build out the 142- *Documentation:* Packages needed if you are going to build out the
140 Yocto Project documentation manuals: $ sudo apt-get install make 143 Yocto Project documentation manuals:
141 xsltproc docbook-utils fop dblatex xmlto 144 ::
145
146 $ sudo apt-get install make xsltproc docbook-utils fop dblatex xmlto
142 147
143Fedora Packages 148Fedora Packages
144--------------- 149---------------
@@ -147,12 +152,17 @@ The following list shows the required packages by function given a
147supported Fedora Linux distribution: 152supported Fedora Linux distribution:
148 153
149- *Essentials:* Packages needed to build an image for a headless 154- *Essentials:* Packages needed to build an image for a headless
150 system: $ sudo dnf install FEDORA_HOST_PACKAGES_ESSENTIAL 155 system:
156 ::
157
158 $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL;
151 159
152- *Documentation:* Packages needed if you are going to build out the 160- *Documentation:* Packages needed if you are going to build out the
153 Yocto Project documentation manuals: $ sudo dnf install 161 Yocto Project documentation manuals:
154 docbook-style-dsssl docbook-style-xsl \\ docbook-dtds docbook-utils 162 ::
155 fop libxslt dblatex xmlto 163
164 $ sudo dnf install docbook-style-dsssl docbook-style-xsl \
165 docbook-dtds docbook-utils fop libxslt dblatex xmlto
156 166
157openSUSE Packages 167openSUSE Packages
158----------------- 168-----------------
@@ -161,7 +171,10 @@ The following list shows the required packages by function given a
161supported openSUSE Linux distribution: 171supported openSUSE Linux distribution:
162 172
163- *Essentials:* Packages needed to build an image for a headless 173- *Essentials:* Packages needed to build an image for a headless
164 system: $ sudo zypper install OPENSUSE_HOST_PACKAGES_ESSENTIAL 174 system:
175 ::
176
177 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
165 178
166- *Documentation:* Packages needed if you are going to build out the 179- *Documentation:* Packages needed if you are going to build out the
167 Yocto Project documentation manuals: $ sudo zypper install dblatex 180 Yocto Project documentation manuals: $ sudo zypper install dblatex
@@ -174,7 +187,10 @@ The following list shows the required packages by function given a
174supported CentOS-7 Linux distribution: 187supported CentOS-7 Linux distribution:
175 188
176- *Essentials:* Packages needed to build an image for a headless 189- *Essentials:* Packages needed to build an image for a headless
177 system: $ sudo yum install CENTOS7_HOST_PACKAGES_ESSENTIAL 190 system:
191 ::
192
193 $ sudo yum install &CENTOS7_HOST_PACKAGES_ESSENTIAL;
178 194
179 .. note:: 195 .. note::
180 196
@@ -187,9 +203,11 @@ supported CentOS-7 Linux distribution:
187 ``epel-release``. 203 ``epel-release``.
188 204
189- *Documentation:* Packages needed if you are going to build out the 205- *Documentation:* Packages needed if you are going to build out the
190 Yocto Project documentation manuals: $ sudo yum install 206 Yocto Project documentation manuals:
191 docbook-style-dsssl docbook-style-xsl \\ docbook-dtds docbook-utils 207 ::
192 fop libxslt dblatex xmlto 208
209 $ sudo yum install docbook-style-dsssl docbook-style-xsl \
210 docbook-dtds docbook-utils fop libxslt dblatex xmlto
193 211
194CentOS-8 Packages 212CentOS-8 Packages
195----------------- 213-----------------
@@ -198,7 +216,10 @@ The following list shows the required packages by function given a
198supported CentOS-8 Linux distribution: 216supported CentOS-8 Linux distribution:
199 217
200- *Essentials:* Packages needed to build an image for a headless 218- *Essentials:* Packages needed to build an image for a headless
201 system: $ sudo dnf install CENTOS8_HOST_PACKAGES_ESSENTIAL 219 system:
220 ::
221
222 $ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL;
202 223
203 .. note:: 224 .. note::
204 225
@@ -214,9 +235,11 @@ supported CentOS-8 Linux distribution:
214 ``epel-release``. 235 ``epel-release``.
215 236
216- *Documentation:* Packages needed if you are going to build out the 237- *Documentation:* Packages needed if you are going to build out the
217 Yocto Project documentation manuals: $ sudo dnf install 238 Yocto Project documentation manuals:
218 docbook-style-dsssl docbook-style-xsl \\ docbook-dtds docbook-utils 239 ::
219 fop libxslt dblatex xmlto 240
241 $ sudo dnf install docbook-style-dsssl docbook-style-xsl \\
242 docbook-dtds docbook-utils fop libxslt dblatex xmlto
220 243
221Required Git, tar, Python and gcc Versions 244Required Git, tar, Python and gcc Versions
222========================================== 245==========================================
@@ -251,10 +274,14 @@ The ``install-buildtools`` script is the easiest of the three methods by
251which you can get these tools. It downloads a pre-built buildtools 274which you can get these tools. It downloads a pre-built buildtools
252installer and automatically installs the tools for you: 275installer and automatically installs the tools for you:
253 276
2541. Execute the ``install-buildtools`` script. Here is an example: $ cd 2771. Execute the ``install-buildtools`` script. Here is an example:
255 poky $ scripts/install-buildtools --without-extended-buildtools \\ 278 ::
256 --base-url https://downloads.yoctoproject.org/releases/yocto \\ --release yocto-DISTRO \\ 279
257 --installer-version DISTRO 280 $ cd poky
281 $ scripts/install-buildtools --without-extended-buildtools \
282 --base-url https://downloads.yoctoproject.org/releases/yocto \
283 --release yocto-&DISTRO; \
284 --installer-version &DISTRO;
258 285
259 During execution, the buildtools tarball will be downloaded, the 286 During execution, the buildtools tarball will be downloaded, the
260 checksum of the download will be verified, the installer will be run 287 checksum of the download will be verified, the installer will be run
@@ -263,17 +290,25 @@ installer and automatically installs the tools for you:
263 290
264 To avoid the need of ``sudo`` privileges, the ``install-buildtools`` 291 To avoid the need of ``sudo`` privileges, the ``install-buildtools``
265 script will by default tell the installer to install in: 292 script will by default tell the installer to install in:
266 /path/to/poky/buildtools 293 ::
294
295 /path/to/poky/buildtools
267 296
268 If your host development system needs the additional tools provided 297 If your host development system needs the additional tools provided
269 in the ``buildtools-extended`` tarball, you can instead execute the 298 in the ``buildtools-extended`` tarball, you can instead execute the
270 ``install-buildtools`` script with the default parameters: $ cd poky 299 ``install-buildtools`` script with the default parameters:
271 $ scripts/install-buildtools 300 ::
301
302 $ cd poky
303 $ scripts/install-buildtools
272 304
2732. Source the tools environment setup script by using a command like the 3052. Source the tools environment setup script by using a command like the
274 following: $ source 306 following:
275 /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux Of 307 ::
276 course, you need to supply your installation directory and be sure to 308
309 $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux
310
311 Of course, you need to supply your installation directory and be sure to
277 use the right file (i.e. i586 or x86_64). 312 use the right file (i.e. i586 or x86_64).
278 313
279 After you have sourced the setup script, the tools are added to 314 After you have sourced the setup script, the tools are added to
@@ -290,21 +325,30 @@ Downloading a Pre-Built ``buildtools`` Tarball
290Downloading and running a pre-built buildtools installer is the easiest 325Downloading and running a pre-built buildtools installer is the easiest
291of the two methods by which you can get these tools: 326of the two methods by which you can get these tools:
292 327
2931. Locate and download the ``*.sh`` at 3281. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/
294 ` <&YOCTO_RELEASE_DL_URL;/buildtools/>`__.
295 329
2962. Execute the installation script. Here is an example for the 3302. Execute the installation script. Here is an example for the
297 traditional installer: $ sh 331 traditional installer:
298 ~/Downloads/x86_64-buildtools-nativesdk-standalone-DISTRO.sh Here is 332 ::
299 an example for the extended installer: $ sh 333
300 ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-DISTRO.sh 334 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-DISTRO.sh
335
336 Here is an example for the extended installer:
337 ::
338
339 $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-DISTRO.sh
340
301 During execution, a prompt appears that allows you to choose the 341 During execution, a prompt appears that allows you to choose the
302 installation directory. For example, you could choose the following: 342 installation directory. For example, you could choose the following:
303 /home/your-username/buildtools 343 /home/your-username/buildtools
304 344
3053. Source the tools environment setup script by using a command like the 3453. Source the tools environment setup script by using a command like the
306 following: $ source 346 following:
307 /home/your_username/buildtools/environment-setup-i586-poky-linux Of 347 ::
348
349 $ source /home/your_username/buildtools/environment-setup-i586-poky-linux
350
351 Of
308 course, you need to supply your installation directory and be sure to 352 course, you need to supply your installation directory and be sure to
309 use the right file (i.e. i585 or x86-64). 353 use the right file (i.e. i585 or x86-64).
310 354
@@ -330,11 +374,17 @@ installer:
330 374
3311. On the machine that is able to run BitBake, be sure you have set up 3751. On the machine that is able to run BitBake, be sure you have set up
332 your build environment with the setup script 376 your build environment with the setup script
333 (````` <#structure-core-script>`__). 377 (:ref:`structure-core-script`).
378
3792. Run the BitBake command to build the tarball:
380 ::
381
382 $ bitbake buildtools-tarball
334 383
3352. Run the BitBake command to build the tarball: $ bitbake 384 or run the BitBake command to build the extended tarball:
336 buildtools-tarball or run the BitBake command to build the extended 385 ::
337 tarball: $ bitbake buildtools-extended-tarball 386
387 $ bitbake buildtools-extended-tarball
338 388
339 .. note:: 389 .. note::
340 390
@@ -355,18 +405,27 @@ installer:
355 405
3564. On the machine that does not meet the requirements, run the ``.sh`` 4064. On the machine that does not meet the requirements, run the ``.sh``
357 file to install the tools. Here is an example for the traditional 407 file to install the tools. Here is an example for the traditional
358 installer: $ sh 408 installer:
359 ~/Downloads/x86_64-buildtools-nativesdk-standalone-DISTRO.sh Here is 409 ::
360 an example for the extended installer: $ sh 410
361 ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-DISTRO.sh 411 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
412
413 Here is an example for the extended installer:
414 ::
415
416 $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh
417
362 During execution, a prompt appears that allows you to choose the 418 During execution, a prompt appears that allows you to choose the
363 installation directory. For example, you could choose the following: 419 installation directory. For example, you could choose the following:
364 /home/your_username/buildtools 420 /home/your_username/buildtools
365 421
3665. Source the tools environment setup script by using a command like the 4225. Source the tools environment setup script by using a command like the
367 following: $ source 423 following:
368 /home/your_username/buildtools/environment-setup-x86_64-poky-linux Of 424 ::
369 course, you need to supply your installation directory and be sure to 425
426 $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux
427
428 Of course, you need to supply your installation directory and be sure to
370 use the right file (i.e. i586 or x86_64). 429 use the right file (i.e. i586 or x86_64).
371 430
372 After you have sourced the setup script, the tools are added to 431 After you have sourced the setup script, the tools are added to