mirror of
https://git.yoctoproject.org/poky
synced 2026-04-23 00:32:12 +02:00
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>
This commit is contained in:
committed by
Richard Purdie
parent
76fa5fae9e
commit
9b9fd2b095
@@ -166,8 +166,9 @@ section.
|
||||
#. *Determine the BSP Layer You Want:* The Yocto Project supports many
|
||||
BSPs, which are maintained in their own layers or in layers designed
|
||||
to contain several BSPs. To get an idea of machine support through
|
||||
BSP layers, you can look at the `index of
|
||||
machines <&YOCTO_RELEASE_DL_URL;/machines>`__ for the release.
|
||||
BSP layers, you can look at the
|
||||
:yocto_dl:`index of machines </releases/yocto/&DISTRO_REL_TAG;/machines>`
|
||||
for the release.
|
||||
|
||||
#. *Optionally Clone the meta-intel BSP Layer:* If your hardware is
|
||||
based on current Intel CPUs and devices, you can leverage this BSP
|
||||
|
||||
@@ -2168,7 +2168,7 @@ recipe, but which one? You can configure your build to call out the
|
||||
kernel recipe you want by using the
|
||||
:term:`PREFERRED_PROVIDER`
|
||||
variable. As an example, consider the
|
||||
`x86-base.inc <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc>`_
|
||||
:yocto_git:`x86-base.inc </cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc>`
|
||||
include file, which is a machine (i.e.
|
||||
:term:`MACHINE`) configuration file.
|
||||
This include file is the reason all x86-based machines use the
|
||||
|
||||
@@ -422,7 +422,7 @@ files. Git uses "branches" to organize different development efforts.
|
||||
For example, the ``poky`` repository has several branches that include
|
||||
the current "&DISTRO_NAME_NO_CAP;" branch, the "master" branch, and many
|
||||
branches for past Yocto Project releases. You can see all the branches
|
||||
by going to https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the
|
||||
by going to :yocto_git:`/cgit.cgi/poky/` and clicking on the
|
||||
``[...]`` link beneath the "Branch" heading.
|
||||
|
||||
Each 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
|
||||
structure. Typically, a tag is used to mark a special point such as the
|
||||
final change (or commit) before a project is released. You can see the
|
||||
tags used with the ``poky`` Git repository by going to
|
||||
https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link
|
||||
:yocto_git:`/cgit.cgi/poky/` and clicking on the ``[...]`` link
|
||||
beneath the "Tag" heading.
|
||||
|
||||
Some key tags for the ``poky`` repository are ``jethro-14.0.3``,
|
||||
|
||||
@@ -271,8 +271,8 @@ with the string ``meta-``.
|
||||
, but it is a commonly accepted standard in the Yocto Project
|
||||
community.
|
||||
|
||||
For example, if you were to examine the `tree
|
||||
view <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/>`__ of the
|
||||
For example, if you were to examine the :yocto_git:`tree
|
||||
view </cgit/cgit.cgi/poky/tree/>` of the
|
||||
``poky`` repository, you will see several layers: ``meta``,
|
||||
``meta-skeleton``, ``meta-selftest``, ``meta-poky``, and
|
||||
``meta-yocto-bsp``. Each of these repositories represents a distinct
|
||||
|
||||
@@ -1169,9 +1169,8 @@ e.g. 'perf help' or 'perf help record'.
|
||||
|
||||
However, by default Yocto doesn't install man pages, but perf invokes
|
||||
the man pages for most help functionality. This is a bug and is being
|
||||
addressed by a Yocto bug: `Bug 3388 - perf: enable man pages for basic
|
||||
'help'
|
||||
functionality <https://bugzilla.yoctoproject.org/show_bug.cgi?id=3388>`__.
|
||||
addressed by a Yocto bug: :yocto_bugs:`Bug 3388 - perf: enable man pages for basic
|
||||
'help' functionality </show_bug.cgi?id=3388>`.
|
||||
|
||||
The man pages in text form, along with some other files, such as a set
|
||||
of examples, can be found in the 'perf' directory of the kernel tree: ::
|
||||
|
||||
@@ -351,7 +351,7 @@ Downloading a Pre-Built ``buildtools`` Tarball
|
||||
Downloading and running a pre-built buildtools installer is the easiest
|
||||
of the two methods by which you can get these tools:
|
||||
|
||||
1. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/
|
||||
1. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/buildtools/`
|
||||
|
||||
2. Execute the installation script. Here is an example for the
|
||||
traditional installer:
|
||||
|
||||
@@ -173,13 +173,13 @@ As shipped, Toaster is configured to work with the following releases:
|
||||
- *Yocto Project &DISTRO; "&DISTRO_NAME;" or OpenEmbedded "&DISTRO_NAME;":*
|
||||
This release causes your Toaster projects to build against the head
|
||||
of the &DISTRO_NAME_NO_CAP; branch at
|
||||
https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP; or
|
||||
:yocto_git:`/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP;` or
|
||||
http://git.openembedded.org/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;.
|
||||
|
||||
- *Yocto Project "Master" or OpenEmbedded "Master":* This release
|
||||
causes your Toaster Projects to build against the head of the master
|
||||
branch, which is where active development takes place, at
|
||||
https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/ or
|
||||
:yocto_git:`/cgit/cgit.cgi/poky/log/` or
|
||||
http://git.openembedded.org/openembedded-core/log/.
|
||||
|
||||
- *Local Yocto Project or Local OpenEmbedded:* This release causes your
|
||||
|
||||
Reference in New Issue
Block a user