summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-03-08 19:43:26 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-03-09 17:53:21 +0000
commit9b9fd2b09543d790c66572d0ea3853dc8a8ba054 (patch)
tree3f67975bad8c2d7cd734863b10a8d06cc7cd3b82 /documentation
parent76fa5fae9e1bd94cd2b5222807620ed917b7c00c (diff)
downloadpoky-9b9fd2b09543d790c66572d0ea3853dc8a8ba054.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: f550001f32157c7c30cf5506f3da783c0fd96396) 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>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/bsp-guide/bsp.rst5
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst2
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.rst4
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst4
-rw-r--r--documentation/profile-manual/profile-manual-usage.rst5
-rw-r--r--documentation/ref-manual/ref-system-requirements.rst2
-rw-r--r--documentation/toaster-manual/toaster-manual-reference.rst4
7 files changed, 13 insertions, 13 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index d0275eea9a..efb5328911 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/&DISTRO_REL_TAG;/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
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index d401d3b4ee..159da6a019 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -2168,7 +2168,7 @@ recipe, but which one? You can configure your build to call out the
2168kernel recipe you want by using the 2168kernel recipe you want by using the
2169:term:`PREFERRED_PROVIDER` 2169:term:`PREFERRED_PROVIDER`
2170variable. As an example, consider the 2170variable. As an example, consider the
2171`x86-base.inc <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc>`_ 2171:yocto_git:`x86-base.inc </cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc>`
2172include file, which is a machine (i.e. 2172include file, which is a machine (i.e.
2173:term:`MACHINE`) configuration file. 2173:term:`MACHINE`) configuration file.
2174This include file is the reason all x86-based machines use the 2174This include file is the reason all x86-based machines use the
diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst
index 4bedd6df67..a5469d4d78 100644
--- a/documentation/overview-manual/overview-manual-development-environment.rst
+++ b/documentation/overview-manual/overview-manual-development-environment.rst
@@ -422,7 +422,7 @@ files. Git uses "branches" to organize different development efforts.
422For example, the ``poky`` repository has several branches that include 422For example, the ``poky`` repository has several branches that include
423the current "&DISTRO_NAME_NO_CAP;" branch, the "master" branch, and many 423the current "&DISTRO_NAME_NO_CAP;" branch, the "master" branch, and many
424branches for past Yocto Project releases. You can see all the branches 424branches for past Yocto Project releases. You can see all the branches
425by going to https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the 425by going to :yocto_git:`/cgit.cgi/poky/` and clicking on the
426``[...]`` link beneath the "Branch" heading. 426``[...]`` link beneath the "Branch" heading.
427 427
428Each of these branches represents a specific area of development. The 428Each of these branches represents a specific area of development. The
@@ -468,7 +468,7 @@ Git uses "tags" to mark specific changes in a repository branch
468structure. Typically, a tag is used to mark a special point such as the 468structure. Typically, a tag is used to mark a special point such as the
469final change (or commit) before a project is released. You can see the 469final change (or commit) before a project is released. You can see the
470tags used with the ``poky`` Git repository by going to 470tags used with the ``poky`` Git repository by going to
471https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link 471:yocto_git:`/cgit.cgi/poky/` and clicking on the ``[...]`` link
472beneath the "Tag" heading. 472beneath the "Tag" heading.
473 473
474Some key tags for the ``poky`` repository are ``jethro-14.0.3``, 474Some key tags for the ``poky`` repository are ``jethro-14.0.3``,
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst
index f1c725ac27..6dd10f2187 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -271,8 +271,8 @@ with the string ``meta-``.
271 , but it is a commonly accepted standard in the Yocto Project 271 , but it is a commonly accepted standard in the Yocto Project
272 community. 272 community.
273 273
274For example, if you were to examine the `tree 274For example, if you were to examine the :yocto_git:`tree
275view <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/>`__ of the 275view </cgit/cgit.cgi/poky/tree/>` of the
276``poky`` repository, you will see several layers: ``meta``, 276``poky`` repository, you will see several layers: ``meta``,
277``meta-skeleton``, ``meta-selftest``, ``meta-poky``, and 277``meta-skeleton``, ``meta-selftest``, ``meta-poky``, and
278``meta-yocto-bsp``. Each of these repositories represents a distinct 278``meta-yocto-bsp``. Each of these repositories represents a distinct
diff --git a/documentation/profile-manual/profile-manual-usage.rst b/documentation/profile-manual/profile-manual-usage.rst
index d3c020a1cf..15cf1efe1c 100644
--- a/documentation/profile-manual/profile-manual-usage.rst
+++ b/documentation/profile-manual/profile-manual-usage.rst
@@ -1169,9 +1169,8 @@ e.g. 'perf help' or 'perf help record'.
1169 1169
1170However, by default Yocto doesn't install man pages, but perf invokes 1170However, by default Yocto doesn't install man pages, but perf invokes
1171the man pages for most help functionality. This is a bug and is being 1171the man pages for most help functionality. This is a bug and is being
1172addressed by a Yocto bug: `Bug 3388 - perf: enable man pages for basic 1172addressed by a Yocto bug: :yocto_bugs:`Bug 3388 - perf: enable man pages for basic
1173'help' 1173'help' functionality </show_bug.cgi?id=3388>`.
1174functionality <https://bugzilla.yoctoproject.org/show_bug.cgi?id=3388>`__.
1175 1174
1176The man pages in text form, along with some other files, such as a set 1175The man pages in text form, along with some other files, such as a set
1177of examples, can be found in the 'perf' directory of the kernel tree: :: 1176of examples, can be found in the 'perf' directory of the kernel tree: ::
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst
index 2acf11cdb8..109aa60d05 100644
--- a/documentation/ref-manual/ref-system-requirements.rst
+++ b/documentation/ref-manual/ref-system-requirements.rst
@@ -351,7 +351,7 @@ Downloading a Pre-Built ``buildtools`` Tarball
351Downloading and running a pre-built buildtools installer is the easiest 351Downloading and running a pre-built buildtools installer is the easiest
352of the two methods by which you can get these tools: 352of the two methods by which you can get these tools:
353 353
3541. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/ 3541. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/buildtools/`
355 355
3562. Execute the installation script. Here is an example for the 3562. Execute the installation script. Here is an example for the
357 traditional installer: 357 traditional installer:
diff --git a/documentation/toaster-manual/toaster-manual-reference.rst b/documentation/toaster-manual/toaster-manual-reference.rst
index e5e3531e83..bd3a060eee 100644
--- a/documentation/toaster-manual/toaster-manual-reference.rst
+++ b/documentation/toaster-manual/toaster-manual-reference.rst
@@ -173,13 +173,13 @@ As shipped, Toaster is configured to work with the following releases:
173- *Yocto Project &DISTRO; "&DISTRO_NAME;" or OpenEmbedded "&DISTRO_NAME;":* 173- *Yocto Project &DISTRO; "&DISTRO_NAME;" or OpenEmbedded "&DISTRO_NAME;":*
174 This release causes your Toaster projects to build against the head 174 This release causes your Toaster projects to build against the head
175 of the &DISTRO_NAME_NO_CAP; branch at 175 of the &DISTRO_NAME_NO_CAP; branch at
176 https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP; or 176 :yocto_git:`/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP;` or
177 http://git.openembedded.org/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;. 177 http://git.openembedded.org/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;.
178 178
179- *Yocto Project "Master" or OpenEmbedded "Master":* This release 179- *Yocto Project "Master" or OpenEmbedded "Master":* This release
180 causes your Toaster Projects to build against the head of the master 180 causes your Toaster Projects to build against the head of the master
181 branch, which is where active development takes place, at 181 branch, which is where active development takes place, at
182 https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/ or 182 :yocto_git:`/cgit/cgit.cgi/poky/log/` or
183 http://git.openembedded.org/openembedded-core/log/. 183 http://git.openembedded.org/openembedded-core/log/.
184 184
185- *Local Yocto Project or Local OpenEmbedded:* This release causes your 185- *Local Yocto Project or Local OpenEmbedded:* This release causes your