diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-12-03 22:38:35 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-09 12:21:27 +0000 |
commit | 097d0c9f04353866302efebcdd0b497c2b89cabb (patch) | |
tree | 305ac5b0776eb37623a9be99a81bee3434a5e4a9 /documentation/what-i-wish-id-known.rst | |
parent | bd1789261122c25d62b8e8e7f7d5647249e8d8ff (diff) | |
download | poky-097d0c9f04353866302efebcdd0b497c2b89cabb.tar.gz |
sphinx: use absolute paths for :doc: references
:doc: references can be made with absolute path instead of relative
path. This patch was generated with this command:
sed -i 's!:doc:`\.\./!:doc:`/!g' */*.rst *.rst
And a few manual fixup we made for references such as:
:doc:"FOOBAR <../xxx>"
Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/what-i-wish-id-known.rst')
-rw-r--r-- | documentation/what-i-wish-id-known.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index 3f9fdea5fa..563594b523 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst | |||
@@ -190,28 +190,28 @@ contact us with other suggestions. | |||
190 | contains procedural information grouped to help you get set up, work with | 190 | contains procedural information grouped to help you get set up, work with |
191 | layers, customize images, write new recipes, work with libraries, and use | 191 | layers, customize images, write new recipes, work with libraries, and use |
192 | QEMU. The information is task-based and spans the breadth of the Yocto | 192 | QEMU. The information is task-based and spans the breadth of the Yocto |
193 | Project. See the :doc:`../dev-manual/index`. | 193 | Project. See the :doc:`/dev-manual/index`. |
194 | 194 | ||
195 | * **Look Through the Yocto Project Application Development and the Extensible | 195 | * **Look Through the Yocto Project Application Development and the Extensible |
196 | Software Development Kit (eSDK) manual**: This manual describes how to use | 196 | Software Development Kit (eSDK) manual**: This manual describes how to use |
197 | both the standard SDK and the extensible SDK, which are used primarily for | 197 | both the standard SDK and the extensible SDK, which are used primarily for |
198 | application development. The :doc:`../sdk-manual/sdk-extensible` also provides | 198 | application development. The :doc:`/sdk-manual/sdk-extensible` also provides |
199 | example workflows that use devtool. See the section | 199 | example workflows that use devtool. See the section |
200 | :ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow` | 200 | :ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow` |
201 | for more information. | 201 | for more information. |
202 | 202 | ||
203 | * **Learn About Kernel Development**: If you want to see how to work with the | 203 | * **Learn About Kernel Development**: If you want to see how to work with the |
204 | kernel and understand Yocto Linux kernels, see the :doc:`../kernel-dev/index`. | 204 | kernel and understand Yocto Linux kernels, see the :doc:`/kernel-dev/index`. |
205 | This manual provides information on how to patch the kernel, modify kernel | 205 | This manual provides information on how to patch the kernel, modify kernel |
206 | recipes, and configure the kernel. | 206 | recipes, and configure the kernel. |
207 | 207 | ||
208 | * **Learn About Board Support Packages (BSPs)**: If you want to learn about | 208 | * **Learn About Board Support Packages (BSPs)**: If you want to learn about |
209 | BSPs, see the :doc:`../bsp-guide/index`. This manual also provides an | 209 | BSPs, see the :doc:`/bsp-guide/index`. This manual also provides an |
210 | example BSP creation workflow. See the :doc:`../bsp-guide/bsp` section. | 210 | example BSP creation workflow. See the :doc:`/bsp-guide/bsp` section. |
211 | 211 | ||
212 | * **Learn About Toaster**: Toaster is a web interface to the Yocto Project's | 212 | * **Learn About Toaster**: Toaster is a web interface to the Yocto Project's |
213 | OpenEmbedded build system. If you are interested in using this type of | 213 | OpenEmbedded build system. If you are interested in using this type of |
214 | interface to create images, see the :doc:`../toaster-manual/index`. | 214 | interface to create images, see the :doc:`/toaster-manual/index`. |
215 | 215 | ||
216 | * **Have Available the Yocto Project Reference Manual**: Unlike the rest of | 216 | * **Have Available the Yocto Project Reference Manual**: Unlike the rest of |
217 | the Yocto Project manual set, this manual is comprised of material suited | 217 | the Yocto Project manual set, this manual is comprised of material suited |
@@ -219,7 +219,7 @@ contact us with other suggestions. | |||
219 | look at how the pieces of the Yocto Project development environment work | 219 | look at how the pieces of the Yocto Project development environment work |
220 | together, information on various technical details, guidance on migrating | 220 | together, information on various technical details, guidance on migrating |
221 | to a newer Yocto Project release, reference material on the directory | 221 | to a newer Yocto Project release, reference material on the directory |
222 | structure, classes, and tasks. The :doc:`../ref-manual/index` also | 222 | structure, classes, and tasks. The :doc:`/ref-manual/index` also |
223 | contains a fairly comprehensive glossary of variables used within the Yocto | 223 | contains a fairly comprehensive glossary of variables used within the Yocto |
224 | Project. | 224 | Project. |
225 | 225 | ||