diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-12-14 09:36:00 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-18 10:41:21 +0000 |
commit | eb5042210c872d9d1a19d9ea251ad48ce589e905 (patch) | |
tree | 6a494267296ee932d66cf2cd24b63ff87943decc /documentation/ref-manual/system-requirements.rst | |
parent | 4925cd416820ab2b48aaa780a053b6fa52d794e9 (diff) | |
download | poky-eb5042210c872d9d1a19d9ea251ad48ce589e905.tar.gz |
manuals: create references to buildtools
On the side, also simplify a reference to the section describing them.
(From yocto-docs rev: 0c13a7f9ccee4ddc9c6034d03f47625a09598cec)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/system-requirements.rst')
-rw-r--r-- | documentation/ref-manual/system-requirements.rst | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index ebb6ca6470..1f9b3b1b58 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
@@ -208,7 +208,7 @@ the following version requirements for Git, tar, and Python: | |||
208 | - GNU make &MIN_MAKE_VERSION; or greater | 208 | - GNU make &MIN_MAKE_VERSION; or greater |
209 | 209 | ||
210 | If your host development system does not meet all these requirements, | 210 | If your host development system does not meet all these requirements, |
211 | you can resolve this by installing a ``buildtools`` tarball that | 211 | you can resolve this by installing a :term:`buildtools` tarball that |
212 | contains these tools. You can either download a pre-built tarball or | 212 | contains these tools. You can either download a pre-built tarball or |
213 | use BitBake to build one. | 213 | use BitBake to build one. |
214 | 214 | ||
@@ -218,23 +218,23 @@ version requirement for gcc: | |||
218 | - gcc &MIN_GCC_VERSION; or greater | 218 | - gcc &MIN_GCC_VERSION; or greater |
219 | 219 | ||
220 | If your host development system does not meet this requirement, you can | 220 | If your host development system does not meet this requirement, you can |
221 | resolve this by installing a ``buildtools-extended`` tarball that | 221 | resolve this by installing a :term:`buildtools-extended` tarball that |
222 | contains additional tools, the equivalent of the Debian/Ubuntu ``build-essential`` | 222 | contains additional tools, the equivalent of the Debian/Ubuntu ``build-essential`` |
223 | package. | 223 | package. |
224 | 224 | ||
225 | For systems with a broken make version (e.g. make 4.2.1 without patches) but | 225 | For systems with a broken make version (e.g. make 4.2.1 without patches) but |
226 | where the rest of the host tools are usable, you can use the ``buildtools-make`` | 226 | where the rest of the host tools are usable, you can use the :term:`buildtools-make` |
227 | tarball instead. | 227 | tarball instead. |
228 | 228 | ||
229 | In the sections that follow, three different methods will be described for | 229 | In the sections that follow, three different methods will be described for |
230 | installing the ``buildtools``, ``buildtools-extended`` or ``buildtools-make`` | 230 | installing the :term:`buildtools`, :term:`buildtools-extended` or :term:`buildtools-make` |
231 | toolset. | 231 | toolset. |
232 | 232 | ||
233 | Installing a Pre-Built ``buildtools`` Tarball with ``install-buildtools`` script | 233 | Installing a Pre-Built ``buildtools`` Tarball with ``install-buildtools`` script |
234 | -------------------------------------------------------------------------------- | 234 | -------------------------------------------------------------------------------- |
235 | 235 | ||
236 | The ``install-buildtools`` script is the easiest of the three methods by | 236 | The ``install-buildtools`` script is the easiest of the three methods by |
237 | which you can get these tools. It downloads a pre-built buildtools | 237 | which you can get these tools. It downloads a pre-built :term:`buildtools` |
238 | installer and automatically installs the tools for you: | 238 | installer and automatically installs the tools for you: |
239 | 239 | ||
240 | #. Execute the ``install-buildtools`` script. Here is an example:: | 240 | #. Execute the ``install-buildtools`` script. Here is an example:: |
@@ -246,7 +246,7 @@ installer and automatically installs the tools for you: | |||
246 | --release yocto-&DISTRO; \ | 246 | --release yocto-&DISTRO; \ |
247 | --installer-version &DISTRO; | 247 | --installer-version &DISTRO; |
248 | 248 | ||
249 | During execution, the buildtools tarball will be downloaded, the | 249 | During execution, the :term:`buildtools` tarball will be downloaded, the |
250 | checksum of the download will be verified, the installer will be run | 250 | checksum of the download will be verified, the installer will be run |
251 | for you, and some basic checks will be run to make sure the | 251 | for you, and some basic checks will be run to make sure the |
252 | installation is functional. | 252 | installation is functional. |
@@ -257,7 +257,7 @@ installer and automatically installs the tools for you: | |||
257 | /path/to/poky/buildtools | 257 | /path/to/poky/buildtools |
258 | 258 | ||
259 | If your host development system needs the additional tools provided | 259 | If your host development system needs the additional tools provided |
260 | in the ``buildtools-extended`` tarball, you can instead execute the | 260 | in the :term:`buildtools-extended` tarball, you can instead execute the |
261 | ``install-buildtools`` script with the default parameters:: | 261 | ``install-buildtools`` script with the default parameters:: |
262 | 262 | ||
263 | $ cd poky | 263 | $ cd poky |
@@ -279,7 +279,7 @@ installer and automatically installs the tools for you: | |||
279 | ``PATH`` and any other environment variables required to run the | 279 | ``PATH`` and any other environment variables required to run the |
280 | tools are initialized. The results are working versions versions of | 280 | tools are initialized. The results are working versions versions of |
281 | Git, tar, Python and ``chrpath``. And in the case of the | 281 | Git, tar, Python and ``chrpath``. And in the case of the |
282 | ``buildtools-extended`` tarball, additional working versions of tools | 282 | :term:`buildtools-extended` tarball, additional working versions of tools |
283 | including ``gcc``, ``make`` and the other tools included in | 283 | including ``gcc``, ``make`` and the other tools included in |
284 | ``packagegroup-core-buildessential``. | 284 | ``packagegroup-core-buildessential``. |
285 | 285 | ||
@@ -287,12 +287,12 @@ Downloading a Pre-Built ``buildtools`` Tarball | |||
287 | ---------------------------------------------- | 287 | ---------------------------------------------- |
288 | 288 | ||
289 | If you would prefer not to use the ``install-buildtools`` script, you can instead | 289 | If you would prefer not to use the ``install-buildtools`` script, you can instead |
290 | download and run a pre-built buildtools installer yourself with the following | 290 | download and run a pre-built :term:`buildtools` installer yourself with the following |
291 | steps: | 291 | steps: |
292 | 292 | ||
293 | #. Go to :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/`, locate and | 293 | #. Go to :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/`, locate and |
294 | download the ``.sh`` file corresponding to your host architecture | 294 | download the ``.sh`` file corresponding to your host architecture |
295 | and to ``buildtools``, ``buildtools-extended`` or ``buildtools-make``. | 295 | and to :term:`buildtools`, :term:`buildtools-extended` or :term:`buildtools-make`. |
296 | 296 | ||
297 | #. Execute the installation script. Here is an example for the | 297 | #. Execute the installation script. Here is an example for the |
298 | traditional installer:: | 298 | traditional installer:: |
@@ -320,20 +320,20 @@ steps: | |||
320 | ``PATH`` and any other environment variables required to run the | 320 | ``PATH`` and any other environment variables required to run the |
321 | tools are initialized. The results are working versions versions of | 321 | tools are initialized. The results are working versions versions of |
322 | Git, tar, Python and ``chrpath``. And in the case of the | 322 | Git, tar, Python and ``chrpath``. And in the case of the |
323 | ``buildtools-extended`` tarball, additional working versions of tools | 323 | :term:`buildtools-extended` tarball, additional working versions of tools |
324 | including ``gcc``, ``make`` and the other tools included in | 324 | including ``gcc``, ``make`` and the other tools included in |
325 | ``packagegroup-core-buildessential``. | 325 | ``packagegroup-core-buildessential``. |
326 | 326 | ||
327 | Building Your Own ``buildtools`` Tarball | 327 | Building Your Own ``buildtools`` Tarball |
328 | ---------------------------------------- | 328 | ---------------------------------------- |
329 | 329 | ||
330 | Building and running your own buildtools installer applies only when you | 330 | Building and running your own :term:`buildtools` installer applies only when you |
331 | have a build host that can already run BitBake. In this case, you use | 331 | have a build host that can already run BitBake. In this case, you use |
332 | that machine to build the ``.sh`` file and then take steps to transfer | 332 | that machine to build the ``.sh`` file and then take steps to transfer |
333 | and run it on a machine that does not meet the minimal Git, tar, and | 333 | and run it on a machine that does not meet the minimal Git, tar, and |
334 | Python (or gcc) requirements. | 334 | Python (or gcc) requirements. |
335 | 335 | ||
336 | Here are the steps to take to build and run your own buildtools | 336 | Here are the steps to take to build and run your own :term:`buildtools` |
337 | installer: | 337 | installer: |
338 | 338 | ||
339 | #. On the machine that is able to run BitBake, be sure you have set up | 339 | #. On the machine that is able to run BitBake, be sure you have set up |
@@ -391,6 +391,6 @@ installer: | |||
391 | ``PATH`` and any other environment variables required to run the | 391 | ``PATH`` and any other environment variables required to run the |
392 | tools are initialized. The results are working versions versions of | 392 | tools are initialized. The results are working versions versions of |
393 | Git, tar, Python and ``chrpath``. And in the case of the | 393 | Git, tar, Python and ``chrpath``. And in the case of the |
394 | ``buildtools-extended`` tarball, additional working versions of tools | 394 | :term:`buildtools-extended` tarball, additional working versions of tools |
395 | including ``gcc``, ``make`` and the other tools included in | 395 | including ``gcc``, ``make`` and the other tools included in |
396 | ``packagegroup-core-buildessential``. | 396 | ``packagegroup-core-buildessential``. |