diff options
Diffstat (limited to 'documentation/ref-manual/system-requirements.rst')
-rw-r--r-- | documentation/ref-manual/system-requirements.rst | 69 |
1 files changed, 23 insertions, 46 deletions
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index 80378cedb7..4fa4d3ef52 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
@@ -120,8 +120,7 @@ supported Ubuntu or Debian Linux distribution: | |||
120 | might experience QEMU build failures due to the package installing | 120 | might experience QEMU build failures due to the package installing |
121 | its own custom ``/usr/include/linux/soundcard.h`` on the Debian | 121 | its own custom ``/usr/include/linux/soundcard.h`` on the Debian |
122 | system. If you run into this situation, either of the following | 122 | system. If you run into this situation, either of the following |
123 | solutions exist: | 123 | solutions exist:: |
124 | :: | ||
125 | 124 | ||
126 | $ sudo apt-get build-dep qemu | 125 | $ sudo apt-get build-dep qemu |
127 | $ sudo apt-get remove oss4-dev | 126 | $ sudo apt-get remove oss4-dev |
@@ -132,14 +131,12 @@ supported Ubuntu or Debian Linux distribution: | |||
132 | 131 | ||
133 | $ sudo pip3 install GitPython pylint==1.9.5 | 132 | $ sudo pip3 install GitPython pylint==1.9.5 |
134 | 133 | ||
135 | - *Essentials:* Packages needed to build an image on a headless system: | 134 | - *Essentials:* Packages needed to build an image on a headless system:: |
136 | :: | ||
137 | 135 | ||
138 | $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; | 136 | $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; |
139 | 137 | ||
140 | - *Documentation:* Packages needed if you are going to build out the | 138 | - *Documentation:* Packages needed if you are going to build out the |
141 | Yocto Project documentation manuals: | 139 | Yocto Project documentation manuals:: |
142 | :: | ||
143 | 140 | ||
144 | $ sudo apt-get install make python3-pip | 141 | $ sudo apt-get install make python3-pip |
145 | &PIP3_HOST_PACKAGES_DOC; | 142 | &PIP3_HOST_PACKAGES_DOC; |
@@ -157,14 +154,12 @@ The following list shows the required packages by function given a | |||
157 | supported Fedora Linux distribution: | 154 | supported Fedora Linux distribution: |
158 | 155 | ||
159 | - *Essentials:* Packages needed to build an image for a headless | 156 | - *Essentials:* Packages needed to build an image for a headless |
160 | system: | 157 | system:: |
161 | :: | ||
162 | 158 | ||
163 | $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; | 159 | $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; |
164 | 160 | ||
165 | - *Documentation:* Packages needed if you are going to build out the | 161 | - *Documentation:* Packages needed if you are going to build out the |
166 | Yocto Project documentation manuals: | 162 | Yocto Project documentation manuals:: |
167 | :: | ||
168 | 163 | ||
169 | $ sudo dnf install make python3-pip which | 164 | $ sudo dnf install make python3-pip which |
170 | &PIP3_HOST_PACKAGES_DOC; | 165 | &PIP3_HOST_PACKAGES_DOC; |
@@ -176,14 +171,12 @@ The following list shows the required packages by function given a | |||
176 | supported openSUSE Linux distribution: | 171 | supported openSUSE Linux distribution: |
177 | 172 | ||
178 | - *Essentials:* Packages needed to build an image for a headless | 173 | - *Essentials:* Packages needed to build an image for a headless |
179 | system: | 174 | system:: |
180 | :: | ||
181 | 175 | ||
182 | $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; | 176 | $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; |
183 | 177 | ||
184 | - *Documentation:* Packages needed if you are going to build out the | 178 | - *Documentation:* Packages needed if you are going to build out the |
185 | Yocto Project documentation manuals: | 179 | Yocto Project documentation manuals:: |
186 | :: | ||
187 | 180 | ||
188 | $ sudo zypper install make python3-pip which | 181 | $ sudo zypper install make python3-pip which |
189 | &PIP3_HOST_PACKAGES_DOC; | 182 | &PIP3_HOST_PACKAGES_DOC; |
@@ -196,8 +189,7 @@ The following list shows the required packages by function given a | |||
196 | supported CentOS-7 Linux distribution: | 189 | supported CentOS-7 Linux distribution: |
197 | 190 | ||
198 | - *Essentials:* Packages needed to build an image for a headless | 191 | - *Essentials:* Packages needed to build an image for a headless |
199 | system: | 192 | system:: |
200 | :: | ||
201 | 193 | ||
202 | $ sudo yum install &CENTOS7_HOST_PACKAGES_ESSENTIAL; | 194 | $ sudo yum install &CENTOS7_HOST_PACKAGES_ESSENTIAL; |
203 | 195 | ||
@@ -212,8 +204,7 @@ supported CentOS-7 Linux distribution: | |||
212 | ``epel-release``. | 204 | ``epel-release``. |
213 | 205 | ||
214 | - *Documentation:* Packages needed if you are going to build out the | 206 | - *Documentation:* Packages needed if you are going to build out the |
215 | Yocto Project documentation manuals: | 207 | Yocto Project documentation manuals:: |
216 | :: | ||
217 | 208 | ||
218 | $ sudo yum install make python3-pip which | 209 | $ sudo yum install make python3-pip which |
219 | &PIP3_HOST_PACKAGES_DOC; | 210 | &PIP3_HOST_PACKAGES_DOC; |
@@ -225,8 +216,7 @@ The following list shows the required packages by function given a | |||
225 | supported CentOS-8 Linux distribution: | 216 | supported CentOS-8 Linux distribution: |
226 | 217 | ||
227 | - *Essentials:* Packages needed to build an image for a headless | 218 | - *Essentials:* Packages needed to build an image for a headless |
228 | system: | 219 | system:: |
229 | :: | ||
230 | 220 | ||
231 | $ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL; | 221 | $ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL; |
232 | 222 | ||
@@ -244,8 +234,7 @@ supported CentOS-8 Linux distribution: | |||
244 | ``epel-release``. | 234 | ``epel-release``. |
245 | 235 | ||
246 | - *Documentation:* Packages needed if you are going to build out the | 236 | - *Documentation:* Packages needed if you are going to build out the |
247 | Yocto Project documentation manuals: | 237 | Yocto Project documentation manuals:: |
248 | :: | ||
249 | 238 | ||
250 | $ sudo dnf install make python3-pip which | 239 | $ sudo dnf install make python3-pip which |
251 | &PIP3_HOST_PACKAGES_DOC; | 240 | &PIP3_HOST_PACKAGES_DOC; |
@@ -287,8 +276,7 @@ The ``install-buildtools`` script is the easiest of the three methods by | |||
287 | which you can get these tools. It downloads a pre-built buildtools | 276 | which you can get these tools. It downloads a pre-built buildtools |
288 | installer and automatically installs the tools for you: | 277 | installer and automatically installs the tools for you: |
289 | 278 | ||
290 | 1. Execute the ``install-buildtools`` script. Here is an example: | 279 | 1. Execute the ``install-buildtools`` script. Here is an example:: |
291 | :: | ||
292 | 280 | ||
293 | $ cd poky | 281 | $ cd poky |
294 | $ scripts/install-buildtools --without-extended-buildtools \ | 282 | $ scripts/install-buildtools --without-extended-buildtools \ |
@@ -302,22 +290,19 @@ installer and automatically installs the tools for you: | |||
302 | installation is functional. | 290 | installation is functional. |
303 | 291 | ||
304 | To avoid the need of ``sudo`` privileges, the ``install-buildtools`` | 292 | To avoid the need of ``sudo`` privileges, the ``install-buildtools`` |
305 | script will by default tell the installer to install in: | 293 | script will by default tell the installer to install in:: |
306 | :: | ||
307 | 294 | ||
308 | /path/to/poky/buildtools | 295 | /path/to/poky/buildtools |
309 | 296 | ||
310 | If your host development system needs the additional tools provided | 297 | If your host development system needs the additional tools provided |
311 | in the ``buildtools-extended`` tarball, you can instead execute the | 298 | in the ``buildtools-extended`` tarball, you can instead execute the |
312 | ``install-buildtools`` script with the default parameters: | 299 | ``install-buildtools`` script with the default parameters:: |
313 | :: | ||
314 | 300 | ||
315 | $ cd poky | 301 | $ cd poky |
316 | $ scripts/install-buildtools | 302 | $ scripts/install-buildtools |
317 | 303 | ||
318 | 2. Source the tools environment setup script by using a command like the | 304 | 2. Source the tools environment setup script by using a command like the |
319 | following: | 305 | following:: |
320 | :: | ||
321 | 306 | ||
322 | $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux | 307 | $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux |
323 | 308 | ||
@@ -342,13 +327,11 @@ steps: | |||
342 | 1. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/ | 327 | 1. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/ |
343 | 328 | ||
344 | 2. Execute the installation script. Here is an example for the | 329 | 2. Execute the installation script. Here is an example for the |
345 | traditional installer: | 330 | traditional installer:: |
346 | :: | ||
347 | 331 | ||
348 | $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh | 332 | $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh |
349 | 333 | ||
350 | Here is an example for the extended installer: | 334 | Here is an example for the extended installer:: |
351 | :: | ||
352 | 335 | ||
353 | $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh | 336 | $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh |
354 | 337 | ||
@@ -357,8 +340,7 @@ steps: | |||
357 | ``/home/your-username/buildtools`` | 340 | ``/home/your-username/buildtools`` |
358 | 341 | ||
359 | 3. Source the tools environment setup script by using a command like the | 342 | 3. Source the tools environment setup script by using a command like the |
360 | following: | 343 | following:: |
361 | :: | ||
362 | 344 | ||
363 | $ source /home/your_username/buildtools/environment-setup-i586-poky-linux | 345 | $ source /home/your_username/buildtools/environment-setup-i586-poky-linux |
364 | 346 | ||
@@ -390,13 +372,11 @@ installer: | |||
390 | your build environment with the setup script | 372 | your build environment with the setup script |
391 | (:ref:`structure-core-script`). | 373 | (:ref:`structure-core-script`). |
392 | 374 | ||
393 | 2. Run the BitBake command to build the tarball: | 375 | 2. Run the BitBake command to build the tarball:: |
394 | :: | ||
395 | 376 | ||
396 | $ bitbake buildtools-tarball | 377 | $ bitbake buildtools-tarball |
397 | 378 | ||
398 | or run the BitBake command to build the extended tarball: | 379 | or run the BitBake command to build the extended tarball:: |
399 | :: | ||
400 | 380 | ||
401 | $ bitbake buildtools-extended-tarball | 381 | $ bitbake buildtools-extended-tarball |
402 | 382 | ||
@@ -415,13 +395,11 @@ installer: | |||
415 | 395 | ||
416 | 4. On the machine that does not meet the requirements, run the ``.sh`` | 396 | 4. On the machine that does not meet the requirements, run the ``.sh`` |
417 | file to install the tools. Here is an example for the traditional | 397 | file to install the tools. Here is an example for the traditional |
418 | installer: | 398 | installer:: |
419 | :: | ||
420 | 399 | ||
421 | $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh | 400 | $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh |
422 | 401 | ||
423 | Here is an example for the extended installer: | 402 | Here is an example for the extended installer:: |
424 | :: | ||
425 | 403 | ||
426 | $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh | 404 | $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh |
427 | 405 | ||
@@ -430,8 +408,7 @@ installer: | |||
430 | ``/home/your_username/buildtools`` | 408 | ``/home/your_username/buildtools`` |
431 | 409 | ||
432 | 5. Source the tools environment setup script by using a command like the | 410 | 5. Source the tools environment setup script by using a command like the |
433 | following: | 411 | following:: |
434 | :: | ||
435 | 412 | ||
436 | $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux | 413 | $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux |
437 | 414 | ||