diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-03-22 15:22:39 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-03-23 12:32:39 +0000 |
commit | ca162b5063ac877eac4987c1b5312109b5157a2a (patch) | |
tree | 60612b111e5456e83543445be2644fd78e56f35b | |
parent | c17b457ac4f3dfad8225d8e9799f2e3ee11309ee (diff) | |
download | poky-ca162b5063ac877eac4987c1b5312109b5157a2a.tar.gz |
docs: fix hardcoded link warning messages
Sphinx complains about hardcoded links which can be replaced by an
extlink.
So let's apply its recommendations.
(From yocto-docs rev: a385999029942ae12b6b5d0dddc3fbbd3be13a02)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/bsp-guide/bsp.rst | 7 | ||||
-rw-r--r-- | documentation/migration-guides/migration-3.4.rst | 2 | ||||
-rw-r--r-- | documentation/overview-manual/yp-intro.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/system-requirements.rst | 2 |
4 files changed, 8 insertions, 7 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 65652ff898..1cc92d721d 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
@@ -166,8 +166,9 @@ section. | |||
166 | #. *Determine the BSP Layer You Want:* The Yocto Project supports many | 166 | #. *Determine the BSP Layer You Want:* The Yocto Project supports many |
167 | BSPs, which are maintained in their own layers or in layers designed | 167 | BSPs, which are maintained in their own layers or in layers designed |
168 | to contain several BSPs. To get an idea of machine support through | 168 | to contain several BSPs. To get an idea of machine support through |
169 | BSP layers, you can look at the `index of | 169 | BSP layers, you can look at the |
170 | machines <&YOCTO_RELEASE_DL_URL;/machines>`__ for the release. | 170 | :yocto_dl:`index of machines </releases/yocto/yocto-&DISTRO;/machines>` |
171 | for the release. | ||
171 | 172 | ||
172 | #. *Optionally Clone the meta-intel BSP Layer:* If your hardware is | 173 | #. *Optionally Clone the meta-intel BSP Layer:* If your hardware is |
173 | based on current Intel CPUs and devices, you can leverage this BSP | 174 | based on current Intel CPUs and devices, you can leverage this BSP |
@@ -877,7 +878,7 @@ Yocto Project: | |||
877 | your BSP layer as listed in the ``recipes.txt`` file, which is found | 878 | your BSP layer as listed in the ``recipes.txt`` file, which is found |
878 | in ``poky/meta`` directory of the :term:`Source Directory` | 879 | in ``poky/meta`` directory of the :term:`Source Directory` |
879 | or in the OpenEmbedded-Core Layer (``openembedded-core``) at | 880 | or in the OpenEmbedded-Core Layer (``openembedded-core``) at |
880 | https://git.openembedded.org/openembedded-core/tree/meta. | 881 | :oe_git:`/openembedded-core/tree/meta`. |
881 | 882 | ||
882 | You should place recipes (``*.bb`` files) and recipe modifications | 883 | You should place recipes (``*.bb`` files) and recipe modifications |
883 | (``*.bbappend`` files) into ``recipes-*`` subdirectories by | 884 | (``*.bbappend`` files) into ``recipes-*`` subdirectories by |
diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index 6105015a24..8143cd4813 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst | |||
@@ -140,7 +140,7 @@ configuration provided and tested by the Yocto Project, there is | |||
140 | simply no sense in continuing to enable prelink. | 140 | simply no sense in continuing to enable prelink. |
141 | 141 | ||
142 | There's also a concern that no one is maintaining the code, and there | 142 | There's also a concern that no one is maintaining the code, and there |
143 | are open bugs (including `this serious one <https://bugzilla.yoctoproject.org/show_bug.cgi?id=14429>`__). | 143 | are open bugs (including :yocto_bugs:`this serious one </show_bug.cgi?id=14429>`). |
144 | Given that prelink does intricate address arithmetic and rewriting | 144 | Given that prelink does intricate address arithmetic and rewriting |
145 | of binaries the best option is to disable the feature. It is recommended | 145 | of binaries the best option is to disable the feature. It is recommended |
146 | that you consider disabling this feature in your own configuration if | 146 | that you consider disabling this feature in your own configuration if |
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 7aee9db04f..3ca81428cf 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst | |||
@@ -217,8 +217,8 @@ your Metadata, the easier it is to cope with future changes. | |||
217 | - Use Board Support Package (BSP) layers from silicon vendors when | 217 | - Use Board Support Package (BSP) layers from silicon vendors when |
218 | possible. | 218 | possible. |
219 | 219 | ||
220 | - Familiarize yourself with the `Yocto Project curated layer | 220 | - Familiarize yourself with the |
221 | index <https://www.yoctoproject.org/software-overview/layers/>`__ | 221 | :yocto_home:`Yocto Project curated layer index</software-overview/layers/>` |
222 | or the :oe_layerindex:`OpenEmbedded layer index <>`. | 222 | or the :oe_layerindex:`OpenEmbedded layer index <>`. |
223 | The latter contains more layers but they are less universally | 223 | The latter contains more layers but they are less universally |
224 | validated. | 224 | validated. |
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index 5c15b6de56..6df59a1745 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
@@ -320,7 +320,7 @@ If you would prefer not to use the ``install-buildtools`` script, you can instea | |||
320 | download and run a pre-built buildtools installer yourself with the following | 320 | download and run a pre-built buildtools installer yourself with the following |
321 | steps: | 321 | steps: |
322 | 322 | ||
323 | 1. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/ | 323 | 1. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/` |
324 | 324 | ||
325 | 2. Execute the installation script. Here is an example for the | 325 | 2. Execute the installation script. Here is an example for the |
326 | traditional installer:: | 326 | traditional installer:: |