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/ref-manual | |
| 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/ref-manual')
| -rw-r--r-- | documentation/ref-manual/faq.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/migration-2.1.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-devtool-reference.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-features.rst | 4 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-release-process.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-structure.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-system-requirements.rst | 6 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-terms.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-variables.rst | 10 | ||||
| -rw-r--r-- | documentation/ref-manual/resources.rst | 18 |
10 files changed, 25 insertions, 25 deletions
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 747561e061..819b6857d9 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
| @@ -47,7 +47,7 @@ Support Package (BSP) layer for it. For more information on how to | |||
| 47 | create a BSP layer, see the | 47 | create a BSP layer, see the |
| 48 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" | 48 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" |
| 49 | section in the Yocto Project Development Tasks Manual and the | 49 | section in the Yocto Project Development Tasks Manual and the |
| 50 | :doc:`../bsp-guide/index`. | 50 | :doc:`/bsp-guide/index`. |
| 51 | 51 | ||
| 52 | Usually, if the board is not completely exotic, adding support in the | 52 | Usually, if the board is not completely exotic, adding support in the |
| 53 | Yocto Project is fairly straightforward. | 53 | Yocto Project is fairly straightforward. |
diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst index 8ea1aa7f0a..25ee21499c 100644 --- a/documentation/ref-manual/migration-2.1.rst +++ b/documentation/ref-manual/migration-2.1.rst | |||
| @@ -234,7 +234,7 @@ functionality almost completely overlapped with the :ref:`standard | |||
| 234 | SDK <sdk-manual/sdk-using:using the standard sdk>` and the | 234 | SDK <sdk-manual/sdk-using:using the standard sdk>` and the |
| 235 | :ref:`extensible SDK <sdk-manual/sdk-extensible:using the extensible sdk>`. For | 235 | :ref:`extensible SDK <sdk-manual/sdk-extensible:using the extensible sdk>`. For |
| 236 | information on these SDKs and how to build and use them, see the | 236 | information on these SDKs and how to build and use them, see the |
| 237 | :doc:`../sdk-manual/index` manual. | 237 | :doc:`/sdk-manual/index` manual. |
| 238 | 238 | ||
| 239 | .. note:: | 239 | .. note:: |
| 240 | 240 | ||
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst index a769b3bd40..83861d271c 100644 --- a/documentation/ref-manual/ref-devtool-reference.rst +++ b/documentation/ref-manual/ref-devtool-reference.rst | |||
| @@ -11,7 +11,7 @@ is a key part of the extensible SDK. | |||
| 11 | 11 | ||
| 12 | This chapter provides a Quick Reference for the ``devtool`` command. For | 12 | This chapter provides a Quick Reference for the ``devtool`` command. For |
| 13 | more information on how to apply the command when using the extensible | 13 | more information on how to apply the command when using the extensible |
| 14 | SDK, see the ":doc:`../sdk-manual/sdk-extensible`" chapter in the Yocto | 14 | SDK, see the ":doc:`/sdk-manual/sdk-extensible`" chapter in the Yocto |
| 15 | Project Application Development and the Extensible Software Development | 15 | Project Application Development and the Extensible Software Development |
| 16 | Kit (eSDK) manual. | 16 | Kit (eSDK) manual. |
| 17 | 17 | ||
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst index c9223e4131..6c85c24181 100644 --- a/documentation/ref-manual/ref-features.rst +++ b/documentation/ref-manual/ref-features.rst | |||
| @@ -261,7 +261,7 @@ these valid features is as follows: | |||
| 261 | 261 | ||
| 262 | - *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and | 262 | - *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and |
| 263 | ``LTTng``. For general information on user-space tools, see the | 263 | ``LTTng``. For general information on user-space tools, see the |
| 264 | :doc:`../sdk-manual/index` manual. | 264 | :doc:`/sdk-manual/index` manual. |
| 265 | 265 | ||
| 266 | - *ssh-server-dropbear:* Installs the Dropbear minimal SSH server. | 266 | - *ssh-server-dropbear:* Installs the Dropbear minimal SSH server. |
| 267 | 267 | ||
| @@ -275,7 +275,7 @@ these valid features is as follows: | |||
| 275 | ``gdb``. For information on GDB, see the | 275 | ``gdb``. For information on GDB, see the |
| 276 | ":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section | 276 | ":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section |
| 277 | in the Yocto Project Development Tasks Manual. For information on | 277 | in the Yocto Project Development Tasks Manual. For information on |
| 278 | tracing and profiling, see the :doc:`../profile-manual/index`. | 278 | tracing and profiling, see the :doc:`/profile-manual/index`. |
| 279 | 279 | ||
| 280 | - *tools-sdk:* Installs a full SDK that runs on the device. | 280 | - *tools-sdk:* Installs a full SDK that runs on the device. |
| 281 | 281 | ||
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst index c77a3bcb18..ec6d233877 100644 --- a/documentation/ref-manual/ref-release-process.rst +++ b/documentation/ref-manual/ref-release-process.rst | |||
| @@ -128,7 +128,7 @@ consists of the following pieces: | |||
| 128 | 128 | ||
| 129 | - :ref:`testimage.bbclass <ref-classes-testimage*>`: This class | 129 | - :ref:`testimage.bbclass <ref-classes-testimage*>`: This class |
| 130 | performs runtime testing of images after they are built. The tests | 130 | performs runtime testing of images after they are built. The tests |
| 131 | are usually used with :doc:`QEMU <../dev-manual/dev-manual-qemu>` | 131 | are usually used with :doc:`QEMU </dev-manual/dev-manual-qemu>` |
| 132 | to boot the images and check the combined runtime result boot | 132 | to boot the images and check the combined runtime result boot |
| 133 | operation and functions. However, the test can also use the IP | 133 | operation and functions. However, the test can also use the IP |
| 134 | address of a machine to test. | 134 | address of a machine to test. |
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst index a172a0b71c..d3a231554f 100644 --- a/documentation/ref-manual/ref-structure.rst +++ b/documentation/ref-manual/ref-structure.rst | |||
| @@ -104,7 +104,7 @@ metadata to define the Poky reference distribution. | |||
| 104 | 104 | ||
| 105 | This directory contains the Yocto Project reference hardware Board | 105 | This directory contains the Yocto Project reference hardware Board |
| 106 | Support Packages (BSPs). For more information on BSPs, see the | 106 | Support Packages (BSPs). For more information on BSPs, see the |
| 107 | :doc:`../bsp-guide/index`. | 107 | :doc:`/bsp-guide/index`. |
| 108 | 108 | ||
| 109 | .. _structure-meta-selftest: | 109 | .. _structure-meta-selftest: |
| 110 | 110 | ||
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst index 937cd0c707..2c7c1e0754 100644 --- a/documentation/ref-manual/ref-system-requirements.rst +++ b/documentation/ref-manual/ref-system-requirements.rst | |||
| @@ -20,9 +20,9 @@ chapter in the Yocto Project Overview and Concepts Manual. | |||
| 20 | 20 | ||
| 21 | If you want to use the Yocto Project to quickly build an image without | 21 | If you want to use the Yocto Project to quickly build an image without |
| 22 | having to understand concepts, work through the | 22 | having to understand concepts, work through the |
| 23 | :doc:`../brief-yoctoprojectqs/index` document. You can find "how-to" | 23 | :doc:`/brief-yoctoprojectqs/index` document. You can find "how-to" |
| 24 | information in the :doc:`../dev-manual/index`. You can find Yocto Project overview | 24 | information in the :doc:`/dev-manual/index`. You can find Yocto Project overview |
| 25 | and conceptual information in the :doc:`../overview-manual/index`. | 25 | and conceptual information in the :doc:`/overview-manual/index`. |
| 26 | 26 | ||
| 27 | .. note:: | 27 | .. note:: |
| 28 | 28 | ||
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst index 3c12a2470c..6f0facf728 100644 --- a/documentation/ref-manual/ref-terms.rst +++ b/documentation/ref-manual/ref-terms.rst | |||
| @@ -380,7 +380,7 @@ universal, the list includes them just in case: | |||
| 380 | The interface enables you to | 380 | The interface enables you to |
| 381 | configure and run your builds. Information about builds is collected | 381 | configure and run your builds. Information about builds is collected |
| 382 | and stored in a database. For information on Toaster, see the | 382 | and stored in a database. For information on Toaster, see the |
| 383 | :doc:`../toaster-manual/index`. | 383 | :doc:`/toaster-manual/index`. |
| 384 | 384 | ||
| 385 | :term:`Upstream` | 385 | :term:`Upstream` |
| 386 | A reference to source code or repositories that are not | 386 | A reference to source code or repositories that are not |
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index 5a52833e84..8411989b69 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst | |||
| @@ -2907,7 +2907,7 @@ system and gives an overview of their function and contents. | |||
| 2907 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" | 2907 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" |
| 2908 | section of the Yocto Project Development Tasks Manual. Reference | 2908 | section of the Yocto Project Development Tasks Manual. Reference |
| 2909 | material for Wic is located in the | 2909 | material for Wic is located in the |
| 2910 | ":doc:`../ref-manual/ref-kickstart`" chapter. | 2910 | ":doc:`/ref-manual/ref-kickstart`" chapter. |
| 2911 | 2911 | ||
| 2912 | :term:`IMAGE_BOOT_FILES` | 2912 | :term:`IMAGE_BOOT_FILES` |
| 2913 | A space-separated list of files installed into the boot partition | 2913 | A space-separated list of files installed into the boot partition |
| @@ -2943,7 +2943,7 @@ system and gives an overview of their function and contents. | |||
| 2943 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" | 2943 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" |
| 2944 | section of the Yocto Project Development Tasks Manual. Reference | 2944 | section of the Yocto Project Development Tasks Manual. Reference |
| 2945 | material for Wic is located in the | 2945 | material for Wic is located in the |
| 2946 | ":doc:`../ref-manual/ref-kickstart`" chapter. | 2946 | ":doc:`/ref-manual/ref-kickstart`" chapter. |
| 2947 | 2947 | ||
| 2948 | :term:`IMAGE_CLASSES` | 2948 | :term:`IMAGE_CLASSES` |
| 2949 | A list of classes that all images should inherit. You typically use | 2949 | A list of classes that all images should inherit. You typically use |
| @@ -8154,7 +8154,7 @@ system and gives an overview of their function and contents. | |||
| 8154 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" | 8154 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" |
| 8155 | section in the Yocto Project Overview and Concepts Manual. For | 8155 | section in the Yocto Project Overview and Concepts Manual. For |
| 8156 | information on setting up a cross-development environment, see the | 8156 | information on setting up a cross-development environment, see the |
| 8157 | :doc:`../sdk-manual/index` manual. | 8157 | :doc:`/sdk-manual/index` manual. |
| 8158 | 8158 | ||
| 8159 | :term:`TOOLCHAIN_OUTPUTNAME` | 8159 | :term:`TOOLCHAIN_OUTPUTNAME` |
| 8160 | This variable defines the name used for the toolchain output. The | 8160 | This variable defines the name used for the toolchain output. The |
| @@ -8184,7 +8184,7 @@ system and gives an overview of their function and contents. | |||
| 8184 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" | 8184 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" |
| 8185 | section in the Yocto Project Overview and Concepts Manual. For | 8185 | section in the Yocto Project Overview and Concepts Manual. For |
| 8186 | information on setting up a cross-development environment, see the | 8186 | information on setting up a cross-development environment, see the |
| 8187 | :doc:`../sdk-manual/index` manual. | 8187 | :doc:`/sdk-manual/index` manual. |
| 8188 | 8188 | ||
| 8189 | :term:`TOPDIR` | 8189 | :term:`TOPDIR` |
| 8190 | The top-level :term:`Build Directory`. BitBake | 8190 | The top-level :term:`Build Directory`. BitBake |
| @@ -8737,7 +8737,7 @@ system and gives an overview of their function and contents. | |||
| 8737 | image, see the | 8737 | image, see the |
| 8738 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" | 8738 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" |
| 8739 | section in the Yocto Project Development Tasks Manual. For details on | 8739 | section in the Yocto Project Development Tasks Manual. For details on |
| 8740 | the kickstart file format, see the ":doc:`../ref-manual/ref-kickstart`" Chapter. | 8740 | the kickstart file format, see the ":doc:`/ref-manual/ref-kickstart`" Chapter. |
| 8741 | 8741 | ||
| 8742 | :term:`WKS_FILE_DEPENDS` | 8742 | :term:`WKS_FILE_DEPENDS` |
| 8743 | When placed in the recipe that builds your image, this variable lists | 8743 | When placed in the recipe that builds your image, this variable lists |
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index e41ce95cf0..fd04593d43 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
| @@ -125,33 +125,33 @@ Here is a list of resources you might find helpful: | |||
| 125 | guide to the BitBake tool. If you want information on BitBake, see | 125 | guide to the BitBake tool. If you want information on BitBake, see |
| 126 | this manual. | 126 | this manual. |
| 127 | 127 | ||
| 128 | - :doc:`../brief-yoctoprojectqs/index` *:* This | 128 | - :doc:`/brief-yoctoprojectqs/index` *:* This |
| 129 | short document lets you experience building an image using the Yocto | 129 | short document lets you experience building an image using the Yocto |
| 130 | Project without having to understand any concepts or details. | 130 | Project without having to understand any concepts or details. |
| 131 | 131 | ||
| 132 | - :doc:`../overview-manual/index` *:* This manual provides overview | 132 | - :doc:`/overview-manual/index` *:* This manual provides overview |
| 133 | and conceptual information about the Yocto Project. | 133 | and conceptual information about the Yocto Project. |
| 134 | 134 | ||
| 135 | - :doc:`../dev-manual/index` *:* This manual is a "how-to" guide | 135 | - :doc:`/dev-manual/index` *:* This manual is a "how-to" guide |
| 136 | that presents procedures useful to both application and system | 136 | that presents procedures useful to both application and system |
| 137 | developers who use the Yocto Project. | 137 | developers who use the Yocto Project. |
| 138 | 138 | ||
| 139 | - :doc:`../sdk-manual/index` *manual :* This | 139 | - :doc:`/sdk-manual/index` *manual :* This |
| 140 | guide provides information that lets you get going with the standard | 140 | guide provides information that lets you get going with the standard |
| 141 | or extensible SDK. An SDK, with its cross-development toolchains, | 141 | or extensible SDK. An SDK, with its cross-development toolchains, |
| 142 | allows you to develop projects inside or outside of the Yocto Project | 142 | allows you to develop projects inside or outside of the Yocto Project |
| 143 | environment. | 143 | environment. |
| 144 | 144 | ||
| 145 | - :doc:`../bsp-guide/bsp` *:* This guide defines the structure | 145 | - :doc:`/bsp-guide/bsp` *:* This guide defines the structure |
| 146 | for BSP components. Having a commonly understood structure encourages | 146 | for BSP components. Having a commonly understood structure encourages |
| 147 | standardization. | 147 | standardization. |
| 148 | 148 | ||
| 149 | - :doc:`../kernel-dev/index` *:* This manual describes | 149 | - :doc:`/kernel-dev/index` *:* This manual describes |
| 150 | how to work with Linux Yocto kernels as well as provides a bit of | 150 | how to work with Linux Yocto kernels as well as provides a bit of |
| 151 | conceptual information on the construction of the Yocto Linux kernel | 151 | conceptual information on the construction of the Yocto Linux kernel |
| 152 | tree. | 152 | tree. |
| 153 | 153 | ||
| 154 | - :doc:`../ref-manual/index` *:* This | 154 | - :doc:`/ref-manual/index` *:* This |
| 155 | manual provides reference material such as variable, task, and class | 155 | manual provides reference material such as variable, task, and class |
| 156 | descriptions. | 156 | descriptions. |
| 157 | 157 | ||
| @@ -161,11 +161,11 @@ Here is a list of resources you might find helpful: | |||
| 161 | which you can easily search for phrases and terms used in the Yocto | 161 | which you can easily search for phrases and terms used in the Yocto |
| 162 | Project documentation set. | 162 | Project documentation set. |
| 163 | 163 | ||
| 164 | - :doc:`../profile-manual/index` *:* This manual presents a set of | 164 | - :doc:`/profile-manual/index` *:* This manual presents a set of |
| 165 | common and generally useful tracing and profiling schemes along with | 165 | common and generally useful tracing and profiling schemes along with |
| 166 | their applications (as appropriate) to each tool. | 166 | their applications (as appropriate) to each tool. |
| 167 | 167 | ||
| 168 | - :doc:`../toaster-manual/index` *:* This manual | 168 | - :doc:`/toaster-manual/index` *:* This manual |
| 169 | introduces and describes how to set up and use Toaster. Toaster is an | 169 | introduces and describes how to set up and use Toaster. Toaster is an |
| 170 | Application Programming Interface (API) and web-based interface to | 170 | Application Programming Interface (API) and web-based interface to |
| 171 | the :term:`OpenEmbedded Build System`, which uses | 171 | the :term:`OpenEmbedded Build System`, which uses |
