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/sdk-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/sdk-manual')
-rw-r--r-- | documentation/sdk-manual/sdk-appendix-customizing.rst | 8 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-appendix-obtain.rst | 8 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-extensible.rst | 4 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-intro.rst | 10 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-working-projects.rst | 3 |
5 files changed, 15 insertions, 18 deletions
diff --git a/documentation/sdk-manual/sdk-appendix-customizing.rst b/documentation/sdk-manual/sdk-appendix-customizing.rst index 8169f2bed8..3bb6ef3a19 100644 --- a/documentation/sdk-manual/sdk-appendix-customizing.rst +++ b/documentation/sdk-manual/sdk-appendix-customizing.rst | |||
@@ -150,7 +150,7 @@ set. If the ``DISTRO_NAME`` variable is not set, the title is derived | |||
150 | from the :term:`DISTRO` variable. | 150 | from the :term:`DISTRO` variable. |
151 | 151 | ||
152 | The | 152 | The |
153 | ```populate_sdk_base`` <&YOCTO_DOCS_REF_URL;#ref-classes-populate-sdk-*>`__ | 153 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` |
154 | class defines the default value of the ``SDK_TITLE`` variable as | 154 | class defines the default value of the ``SDK_TITLE`` variable as |
155 | follows: SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or | 155 | follows: SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or |
156 | d.getVar('DISTRO')} SDK" | 156 | d.getVar('DISTRO')} SDK" |
@@ -212,7 +212,7 @@ installation directory for the SDK is based on the | |||
212 | :term:`DISTRO` and | 212 | :term:`DISTRO` and |
213 | :term:`SDKEXTPATH` variables from | 213 | :term:`SDKEXTPATH` variables from |
214 | within the | 214 | within the |
215 | ```populate_sdk_base`` <&YOCTO_DOCS_REF_URL;#ref-classes-populate-sdk-*>`__ | 215 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` |
216 | class as follows: SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" You can | 216 | class as follows: SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" You can |
217 | change this default installation directory by specifically setting the | 217 | change this default installation directory by specifically setting the |
218 | ``SDKEXTPATH`` variable. | 218 | ``SDKEXTPATH`` variable. |
@@ -276,8 +276,8 @@ source, you need to do a number of things: | |||
276 | 276 | ||
277 | - Alternatively, if you just want to set the ``SSTATE_MIRRORS`` | 277 | - Alternatively, if you just want to set the ``SSTATE_MIRRORS`` |
278 | variable's value for the SDK alone, create a | 278 | variable's value for the SDK alone, create a |
279 | ``conf/sdk-extra.conf`` file either in your `Build | 279 | ``conf/sdk-extra.conf`` file either in your |
280 | Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ or within any | 280 | :term:`Build Directory` or within any |
281 | layer and put your ``SSTATE_MIRRORS`` setting within that file. | 281 | layer and put your ``SSTATE_MIRRORS`` setting within that file. |
282 | 282 | ||
283 | .. note:: | 283 | .. note:: |
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.rst b/documentation/sdk-manual/sdk-appendix-obtain.rst index c6efdf674c..015506de01 100644 --- a/documentation/sdk-manual/sdk-appendix-obtain.rst +++ b/documentation/sdk-manual/sdk-appendix-obtain.rst | |||
@@ -70,8 +70,8 @@ build the SDK installer. Follow these steps: | |||
70 | machine that uses CROPS. | 70 | machine that uses CROPS. |
71 | 71 | ||
72 | 2. *Clone the ``poky`` Repository:* You need to have a local copy of the | 72 | 2. *Clone the ``poky`` Repository:* You need to have a local copy of the |
73 | Yocto Project `Source | 73 | Yocto Project :term:`Source Directory` |
74 | Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ (i.e. a local | 74 | (i.e. a local |
75 | ``poky`` repository). See the "`Cloning the ``poky`` | 75 | ``poky`` repository). See the "`Cloning the ``poky`` |
76 | Repository <&YOCTO_DOCS_DEV_URL;#cloning-the-poky-repository>`__" and | 76 | Repository <&YOCTO_DOCS_DEV_URL;#cloning-the-poky-repository>`__" and |
77 | possibly the "`Checking Out by Branch in | 77 | possibly the "`Checking Out by Branch in |
@@ -87,8 +87,8 @@ build the SDK installer. Follow these steps: | |||
87 | ````` <&YOCTO_DOCS_REF_URL;#structure-core-script>`__ environment | 87 | ````` <&YOCTO_DOCS_REF_URL;#structure-core-script>`__ environment |
88 | setup script to define the OpenEmbedded build environment on your | 88 | setup script to define the OpenEmbedded build environment on your |
89 | build host. $ source OE_INIT_FILE Among other things, the script | 89 | build host. $ source OE_INIT_FILE Among other things, the script |
90 | creates the `Build | 90 | creates the :term:`Build Directory`, |
91 | Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__, which is | 91 | which is |
92 | ``build`` in this case and is located in the Source Directory. After | 92 | ``build`` in this case and is located in the Source Directory. After |
93 | the script runs, your current working directory is set to the | 93 | the script runs, your current working directory is set to the |
94 | ``build`` directory. | 94 | ``build`` directory. |
diff --git a/documentation/sdk-manual/sdk-extensible.rst b/documentation/sdk-manual/sdk-extensible.rst index 17cd08a25c..3df2174fd9 100644 --- a/documentation/sdk-manual/sdk-extensible.rst +++ b/documentation/sdk-manual/sdk-extensible.rst | |||
@@ -9,8 +9,8 @@ Information covers the pieces of the SDK, how to install it, and | |||
9 | presents a look at using the ``devtool`` functionality. The extensible | 9 | presents a look at using the ``devtool`` functionality. The extensible |
10 | SDK makes it easy to add new applications and libraries to an image, | 10 | SDK makes it easy to add new applications and libraries to an image, |
11 | modify the source for an existing component, test changes on the target | 11 | modify the source for an existing component, test changes on the target |
12 | hardware, and ease integration into the rest of the `OpenEmbedded build | 12 | hardware, and ease integration into the rest of the |
13 | system <&YOCTO_DOCS_REF_URL;#build-system-term>`__. | 13 | :term:`OpenEmbedded Build System`. |
14 | 14 | ||
15 | .. note:: | 15 | .. note:: |
16 | 16 | ||
diff --git a/documentation/sdk-manual/sdk-intro.rst b/documentation/sdk-manual/sdk-intro.rst index fcb15a8592..88238d7dd4 100644 --- a/documentation/sdk-manual/sdk-intro.rst +++ b/documentation/sdk-manual/sdk-intro.rst | |||
@@ -39,8 +39,7 @@ All SDKs consist of the following: | |||
39 | Additionally, an extensible SDK has tools that allow you to easily add | 39 | Additionally, an extensible SDK has tools that allow you to easily add |
40 | new applications and libraries to an image, modify the source of an | 40 | new applications and libraries to an image, modify the source of an |
41 | existing component, test changes on the target hardware, and easily | 41 | existing component, test changes on the target hardware, and easily |
42 | integrate an application into the `OpenEmbedded build | 42 | integrate an application into the :term:`OpenEmbedded Build System`. |
43 | system <&YOCTO_DOCS_REF_URL;#build-system-term>`__. | ||
44 | 43 | ||
45 | You can use an SDK to independently develop and test code that is | 44 | You can use an SDK to independently develop and test code that is |
46 | destined to run on some target machine. SDKs are completely | 45 | destined to run on some target machine. SDKs are completely |
@@ -126,8 +125,7 @@ of a cross-compiler, cross-linker, and cross-debugger that are used to | |||
126 | develop user-space applications for targeted hardware. Additionally, for | 125 | develop user-space applications for targeted hardware. Additionally, for |
127 | an extensible SDK, the toolchain also has built-in ``devtool`` | 126 | an extensible SDK, the toolchain also has built-in ``devtool`` |
128 | functionality. This toolchain is created by running a SDK installer | 127 | functionality. This toolchain is created by running a SDK installer |
129 | script or through a `Build | 128 | script or through a :term:`Build Directory` that is based on |
130 | Directory <&YOCTO_DOCS_REF_URL;#build-directory>`__ that is based on | ||
131 | your metadata configuration or extension for your targeted device. The | 129 | your metadata configuration or extension for your targeted device. The |
132 | cross-toolchain works with a matching target sysroot. | 130 | cross-toolchain works with a matching target sysroot. |
133 | 131 | ||
@@ -149,8 +147,8 @@ The QEMU emulator allows you to simulate your hardware while running | |||
149 | your application or image. QEMU is not part of the SDK but is made | 147 | your application or image. QEMU is not part of the SDK but is made |
150 | available a number of different ways: | 148 | available a number of different ways: |
151 | 149 | ||
152 | - If you have cloned the ``poky`` Git repository to create a `Source | 150 | - If you have cloned the ``poky`` Git repository to create a |
153 | Directory <&YOCTO_DOCS_REF_URL;#source-directory>`__ and you have | 151 | :term:`Source Directory` and you have |
154 | sourced the environment setup script, QEMU is installed and | 152 | sourced the environment setup script, QEMU is installed and |
155 | automatically available. | 153 | automatically available. |
156 | 154 | ||
diff --git a/documentation/sdk-manual/sdk-working-projects.rst b/documentation/sdk-manual/sdk-working-projects.rst index 63f61de66d..d18568d60a 100644 --- a/documentation/sdk-manual/sdk-working-projects.rst +++ b/documentation/sdk-manual/sdk-working-projects.rst | |||
@@ -14,8 +14,7 @@ Once you have a suitable `cross-development | |||
14 | toolchain <&YOCTO_DOCS_REF_URL;#cross-development-toolchain>`__ | 14 | toolchain <&YOCTO_DOCS_REF_URL;#cross-development-toolchain>`__ |
15 | installed, it is very easy to develop a project using the `GNU | 15 | installed, it is very easy to develop a project using the `GNU |
16 | Autotools-based <https://en.wikipedia.org/wiki/GNU_Build_System>`__ | 16 | Autotools-based <https://en.wikipedia.org/wiki/GNU_Build_System>`__ |
17 | workflow, which is outside of the `OpenEmbedded build | 17 | workflow, which is outside of the :term:`OpenEmbedded Build System`. |
18 | system <&YOCTO_DOCS_REF_URL;#build-system-term>`__. | ||
19 | 18 | ||
20 | The following figure presents a simple Autotools workflow. | 19 | The following figure presents a simple Autotools workflow. |
21 | 20 | ||