diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-27 17:38:09 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:33 +0100 |
commit | 424567d629b08785a6594d16427ee0fa8c31f384 (patch) | |
tree | 4985979745b1c5601f7a82c662042fb745bfd7db /documentation/adt-manual | |
parent | 4bf6fc5281d1976ad7113c91a93995406cfab429 (diff) | |
download | poky-424567d629b08785a6594d16427ee0fa8c31f384.tar.gz |
sphinx: manual updates for some links
Some links were not found by the regexp, especially because of they
are spanning across multiple lines. This patch is a manual fixup for
these patterns.
(From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/adt-manual')
-rw-r--r-- | documentation/adt-manual/adt-command.rst | 4 | ||||
-rw-r--r-- | documentation/adt-manual/adt-intro.rst | 14 | ||||
-rw-r--r-- | documentation/adt-manual/adt-package.rst | 2 | ||||
-rw-r--r-- | documentation/adt-manual/adt-prepare.rst | 29 |
4 files changed, 23 insertions, 26 deletions
diff --git a/documentation/adt-manual/adt-command.rst b/documentation/adt-manual/adt-command.rst index 8b86544f19..de854772bb 100644 --- a/documentation/adt-manual/adt-command.rst +++ b/documentation/adt-manual/adt-command.rst | |||
@@ -6,8 +6,8 @@ Using the Command Line | |||
6 | 6 | ||
7 | Recall that earlier the manual discussed how to use an existing | 7 | Recall that earlier the manual discussed how to use an existing |
8 | toolchain tarball that had been installed into the default installation | 8 | toolchain tarball that had been installed into the default installation |
9 | directory, ``/opt/poky/DISTRO``, which is outside of the `Build | 9 | directory, ``/opt/poky/DISTRO``, which is outside of the :term:`Build Directory` |
10 | Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__ (see the section | 10 | (see the section |
11 | "`Using a Cross-Toolchain | 11 | "`Using a Cross-Toolchain |
12 | Tarball) <#using-an-existing-toolchain-tarball>`__". And, that sourcing | 12 | Tarball) <#using-an-existing-toolchain-tarball>`__". And, that sourcing |
13 | your architecture-specific environment setup script initializes a | 13 | your architecture-specific environment setup script initializes a |
diff --git a/documentation/adt-manual/adt-intro.rst b/documentation/adt-manual/adt-intro.rst index 40612bdddf..d6228ad864 100644 --- a/documentation/adt-manual/adt-intro.rst +++ b/documentation/adt-manual/adt-intro.rst | |||
@@ -12,8 +12,8 @@ application. | |||
12 | Fundamentally, the ADT consists of the following: | 12 | Fundamentally, the ADT consists of the following: |
13 | 13 | ||
14 | - An architecture-specific cross-toolchain and matching sysroot both | 14 | - An architecture-specific cross-toolchain and matching sysroot both |
15 | built by the `OpenEmbedded build | 15 | built by the :term:`OpenEmbedded Build System`. |
16 | system <&YOCTO_DOCS_DEV_URL;#build-system-term>`__. The toolchain and | 16 | The toolchain and |
17 | sysroot are based on a `Metadata <&YOCTO_DOCS_DEV_URL;#metadata>`__ | 17 | sysroot are based on a `Metadata <&YOCTO_DOCS_DEV_URL;#metadata>`__ |
18 | configuration and extensions, which allows you to cross-develop on | 18 | configuration and extensions, which allows you to cross-develop on |
19 | the host machine for the target hardware. | 19 | the host machine for the target hardware. |
@@ -33,8 +33,8 @@ Toolchain <&YOCTO_DOCS_DEV_URL;#cross-development-toolchain>`__ consists | |||
33 | of a cross-compiler, cross-linker, and cross-debugger that are used to | 33 | of a cross-compiler, cross-linker, and cross-debugger that are used to |
34 | develop user-space applications for targeted hardware. This toolchain is | 34 | develop user-space applications for targeted hardware. This toolchain is |
35 | created either by running the ADT Installer script, a toolchain | 35 | created either by running the ADT Installer script, a toolchain |
36 | installer script, or through a `Build | 36 | installer script, or through a :term:`Build Directory` |
37 | Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__ that is based on | 37 | that is based on |
38 | your Metadata configuration or extension for your targeted device. The | 38 | your Metadata configuration or extension for your targeted device. The |
39 | cross-toolchain works with a matching target sysroot. | 39 | cross-toolchain works with a matching target sysroot. |
40 | 40 | ||
@@ -79,13 +79,13 @@ your application or image. QEMU is made available a number of ways: | |||
79 | - If you use the ADT Installer script to install ADT, you can specify | 79 | - If you use the ADT Installer script to install ADT, you can specify |
80 | whether or not to install QEMU. | 80 | whether or not to install QEMU. |
81 | 81 | ||
82 | - If you have cloned the ``poky`` Git repository to create a `Source | 82 | - If you have cloned the ``poky`` Git repository to create a |
83 | Directory <&YOCTO_DOCS_DEV_URL;#source-directory>`__ and you have | 83 | :term:`Source Directory` and you have |
84 | sourced the environment setup script, QEMU is installed and | 84 | sourced the environment setup script, QEMU is installed and |
85 | automatically available. | 85 | automatically available. |
86 | 86 | ||
87 | - If you have downloaded a Yocto Project release and unpacked it to | 87 | - If you have downloaded a Yocto Project release and unpacked it to |
88 | create a `Source Directory <&YOCTO_DOCS_DEV_URL;#source-directory>`__ | 88 | create a :term:`Source Directory` |
89 | and you have sourced the environment setup script, QEMU is installed | 89 | and you have sourced the environment setup script, QEMU is installed |
90 | and automatically available. | 90 | and automatically available. |
91 | 91 | ||
diff --git a/documentation/adt-manual/adt-package.rst b/documentation/adt-manual/adt-package.rst index 38823a104f..dfa62163b3 100644 --- a/documentation/adt-manual/adt-package.rst +++ b/documentation/adt-manual/adt-package.rst | |||
@@ -59,7 +59,7 @@ add it into a working ``opkg`` repository. Use these commands: $ bitbake | |||
59 | libglade $ bitbake package-index | 59 | libglade $ bitbake package-index |
60 | 60 | ||
61 | Next, source the cross-toolchain environment setup script found in the | 61 | Next, source the cross-toolchain environment setup script found in the |
62 | `Source Directory <&YOCTO_DOCS_DEV_URL;#source-directory>`__. Follow | 62 | :term:`Source Directory`. Follow |
63 | that by setting up the installation destination to point to your sysroot | 63 | that by setting up the installation destination to point to your sysroot |
64 | as sysroot_dir. Finally, have an OPKG configuration file conf_file that | 64 | as sysroot_dir. Finally, have an OPKG configuration file conf_file that |
65 | corresponds to the ``opkg`` repository you have just created. The | 65 | corresponds to the ``opkg`` repository you have just created. The |
diff --git a/documentation/adt-manual/adt-prepare.rst b/documentation/adt-manual/adt-prepare.rst index 12b1e7918c..27133d21b4 100644 --- a/documentation/adt-manual/adt-prepare.rst +++ b/documentation/adt-manual/adt-prepare.rst | |||
@@ -50,7 +50,7 @@ for more information. | |||
50 | other mentioned benefits had you run the ADT Installer script. | 50 | other mentioned benefits had you run the ADT Installer script. |
51 | 51 | ||
52 | - *Use the toolchain from within the Build Directory:* If you already | 52 | - *Use the toolchain from within the Build Directory:* If you already |
53 | have a `Build Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__, | 53 | have a :term:`Build Directory`, |
54 | you can build the cross-toolchain within the directory. However, like | 54 | you can build the cross-toolchain within the directory. However, like |
55 | the previous method mentioned, you only get the cross-toolchain and | 55 | the previous method mentioned, you only get the cross-toolchain and |
56 | QEMU - you do not get any of the other benefits without taking | 56 | QEMU - you do not get any of the other benefits without taking |
@@ -79,9 +79,8 @@ the tarball using either of these methods: | |||
79 | ` <&YOCTO_ADTINSTALLER_DL_URL;>`__ into any directory. | 79 | ` <&YOCTO_ADTINSTALLER_DL_URL;>`__ into any directory. |
80 | 80 | ||
81 | - *Build the Tarball:* You can use | 81 | - *Build the Tarball:* You can use |
82 | `BitBake <&YOCTO_DOCS_DEV_URL;#bitbake-term>`__ to generate the | 82 | :term:`BitBake` to generate the |
83 | tarball inside an existing `Build | 83 | tarball inside an existing :term:`Build Directory`. |
84 | Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__. | ||
85 | 84 | ||
86 | If you use BitBake to generate the ADT Installer tarball, you must | 85 | If you use BitBake to generate the ADT Installer tarball, you must |
87 | ``source`` the environment setup script | 86 | ``source`` the environment setup script |
@@ -90,8 +89,8 @@ the tarball using either of these methods: | |||
90 | located in the Source Directory before running the ``bitbake`` | 89 | located in the Source Directory before running the ``bitbake`` |
91 | command that creates the tarball. | 90 | command that creates the tarball. |
92 | 91 | ||
93 | The following example commands establish the `Source | 92 | The following example commands establish the |
94 | Directory <&YOCTO_DOCS_DEV_URL;#source-directory>`__, check out the | 93 | :term:`Source Directory`, check out the |
95 | current release branch, set up the build environment while also | 94 | current release branch, set up the build environment while also |
96 | creating the default Build Directory, and run the ``bitbake`` command | 95 | creating the default Build Directory, and run the ``bitbake`` command |
97 | that results in the tarball | 96 | that results in the tarball |
@@ -268,8 +267,8 @@ Using BitBake and the Build Directory | |||
268 | ------------------------------------- | 267 | ------------------------------------- |
269 | 268 | ||
270 | A final way of making the cross-toolchain available is to use BitBake to | 269 | A final way of making the cross-toolchain available is to use BitBake to |
271 | generate the toolchain within an existing `Build | 270 | generate the toolchain within an existing :term:`Build Directory`. |
272 | Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__. This method does | 271 | This method does |
273 | not install the toolchain into the default ``/opt`` directory. As with | 272 | not install the toolchain into the default ``/opt`` directory. As with |
274 | the previous method, if you need to install the target sysroot, you must | 273 | the previous method, if you need to install the target sysroot, you must |
275 | do that separately as well. | 274 | do that separately as well. |
@@ -280,8 +279,7 @@ Follow these steps to generate the toolchain into the Build Directory: | |||
280 | environment setup script (i.e. | 279 | environment setup script (i.e. |
281 | ````` <&YOCTO_DOCS_REF_URL;#structure-core-script>`__ or | 280 | ````` <&YOCTO_DOCS_REF_URL;#structure-core-script>`__ or |
282 | ```oe-init-build-env-memres`` <&YOCTO_DOCS_REF_URL;#structure-memres-core-script>`__) | 281 | ```oe-init-build-env-memres`` <&YOCTO_DOCS_REF_URL;#structure-memres-core-script>`__) |
283 | located in the `Source | 282 | located in the :term:`Source Directory`. |
284 | Directory <&YOCTO_DOCS_DEV_URL;#source-directory>`__. | ||
285 | 283 | ||
286 | 2. *Check your Local Configuration File:* At this point, you should be | 284 | 2. *Check your Local Configuration File:* At this point, you should be |
287 | sure that the :term:`MACHINE` | 285 | sure that the :term:`MACHINE` |
@@ -332,8 +330,8 @@ cross-development environment by sourcing the toolchain's environment | |||
332 | setup script. If you used the ADT Installer or hand-installed | 330 | setup script. If you used the ADT Installer or hand-installed |
333 | cross-toolchain, then you can find this script in the directory you | 331 | cross-toolchain, then you can find this script in the directory you |
334 | chose for installation. For this release, the default installation | 332 | chose for installation. For this release, the default installation |
335 | directory is ````. If you installed the toolchain in the `Build | 333 | directory is ````. If you installed the toolchain in the |
336 | Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__, you can find the | 334 | :term:`Build Directory`, you can find the |
337 | environment setup script for the toolchain in the Build Directory's | 335 | environment setup script for the toolchain in the Build Directory's |
338 | ``tmp`` directory. | 336 | ``tmp`` directory. |
339 | 337 | ||
@@ -432,8 +430,8 @@ this by including the ``eclipse-debug`` image feature. | |||
432 | image features. | 430 | image features. |
433 | 431 | ||
434 | To include the ``eclipse-debug`` image feature, modify your | 432 | To include the ``eclipse-debug`` image feature, modify your |
435 | ``local.conf`` file in the `Build | 433 | ``local.conf`` file in the :term:`Build Directory` |
436 | Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__ so that the | 434 | so that the |
437 | :term:`EXTRA_IMAGE_FEATURES` | 435 | :term:`EXTRA_IMAGE_FEATURES` |
438 | variable includes the "eclipse-debug" feature. After modifying the | 436 | variable includes the "eclipse-debug" feature. After modifying the |
439 | configuration file, you can rebuild the image. Once the image is | 437 | configuration file, you can rebuild the image. Once the image is |
@@ -484,8 +482,7 @@ Optionally Building a Toolchain Installer | |||
484 | ========================================= | 482 | ========================================= |
485 | 483 | ||
486 | As an alternative to locating and downloading a toolchain installer, you | 484 | As an alternative to locating and downloading a toolchain installer, you |
487 | can build the toolchain installer if you have a `Build | 485 | can build the toolchain installer if you have a :term:`Build Directory`. |
488 | Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__. | ||
489 | 486 | ||
490 | .. note:: | 487 | .. note:: |
491 | 488 | ||