mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 05:29:32 +00:00
Code Issues Projects Releases Wiki Activity

sphinx: use absolute paths for :doc: references

Browse Source 
: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>
This commit is contained in:
Nicolas Dechesne
2020-12-03 22:38:35 +01:00
committed by Richard Purdie
parent bd17892611
commit 097d0c9f04
23 changed files with 79 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/faq.rst
+1 -1
View File
@@ -47,7 +47,7 @@ Support Package (BSP) layer for it. For more information on how to
create a BSP layer, see the
":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`"
section in the Yocto Project Development Tasks Manual and the
:doc:`../bsp-guide/index`.
:doc:`/bsp-guide/index`.
Usually, if the board is not completely exotic, adding support in the
Yocto Project is fairly straightforward.
documentation/ref-manual/migration-2.1.rst
+1 -1
View File
@@ -234,7 +234,7 @@ functionality almost completely overlapped with the :ref:`standard
SDK <sdk-manual/sdk-using:using the standard sdk>` and the
:ref:`extensible SDK <sdk-manual/sdk-extensible:using the extensible sdk>`. For
information on these SDKs and how to build and use them, see the
:doc:`../sdk-manual/index` manual.
:doc:`/sdk-manual/index` manual.
.. note::
documentation/ref-manual/ref-devtool-reference.rst
+1 -1
View File
@@ -11,7 +11,7 @@ is a key part of the extensible SDK.
This chapter provides a Quick Reference for the ``devtool`` command. For
more information on how to apply the command when using the extensible
SDK, see the ":doc:`../sdk-manual/sdk-extensible`" chapter in the Yocto
SDK, see the ":doc:`/sdk-manual/sdk-extensible`" chapter in the Yocto
Project Application Development and the Extensible Software Development
Kit (eSDK) manual.
documentation/ref-manual/ref-features.rst
+2 -2
View File
@@ -261,7 +261,7 @@ these valid features is as follows:
- *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and
``LTTng``. For general information on user-space tools, see the
:doc:`../sdk-manual/index` manual.
:doc:`/sdk-manual/index` manual.
- *ssh-server-dropbear:* Installs the Dropbear minimal SSH server.
@@ -275,7 +275,7 @@ these valid features is as follows:
``gdb``. For information on GDB, see the
":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section
in the Yocto Project Development Tasks Manual. For information on
tracing and profiling, see the :doc:`../profile-manual/index`.
tracing and profiling, see the :doc:`/profile-manual/index`.
- *tools-sdk:* Installs a full SDK that runs on the device.
documentation/ref-manual/ref-release-process.rst
+1 -1
View File
@@ -128,7 +128,7 @@ consists of the following pieces:
- :ref:`testimage.bbclass <ref-classes-testimage*>`: This class
performs runtime testing of images after they are built. The tests
are usually used with :doc:`QEMU <../dev-manual/dev-manual-qemu>`
are usually used with :doc:`QEMU </dev-manual/dev-manual-qemu>`
to boot the images and check the combined runtime result boot
operation and functions. However, the test can also use the IP
address of a machine to test.
documentation/ref-manual/ref-structure.rst
+1 -1
View File
@@ -104,7 +104,7 @@ metadata to define the Poky reference distribution.
This directory contains the Yocto Project reference hardware Board
Support Packages (BSPs). For more information on BSPs, see the
:doc:`../bsp-guide/index`.
:doc:`/bsp-guide/index`.
.. _structure-meta-selftest:
documentation/ref-manual/ref-system-requirements.rst
+3 -3
View File
@@ -20,9 +20,9 @@ chapter in the Yocto Project Overview and Concepts Manual.
If you want to use the Yocto Project to quickly build an image without
having to understand concepts, work through the
:doc:`../brief-yoctoprojectqs/index` document. You can find "how-to"
information in the :doc:`../dev-manual/index`. You can find Yocto Project overview
and conceptual information in the :doc:`../overview-manual/index`.
:doc:`/brief-yoctoprojectqs/index` document. You can find "how-to"
information in the :doc:`/dev-manual/index`. You can find Yocto Project overview
and conceptual information in the :doc:`/overview-manual/index`.
.. note::
documentation/ref-manual/ref-terms.rst
+1 -1
View File
@@ -380,7 +380,7 @@ universal, the list includes them just in case:
The interface enables you to
configure and run your builds. Information about builds is collected
and stored in a database. For information on Toaster, see the
:doc:`../toaster-manual/index`.
:doc:`/toaster-manual/index`.
:term:`Upstream`
A reference to source code or repositories that are not
documentation/ref-manual/ref-variables.rst
+5 -5
View File
@@ -2907,7 +2907,7 @@ system and gives an overview of their function and contents.
":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`"
section of the Yocto Project Development Tasks Manual. Reference
material for Wic is located in the
":doc:`../ref-manual/ref-kickstart`" chapter.
":doc:`/ref-manual/ref-kickstart`" chapter.
:term:`IMAGE_BOOT_FILES`
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.
":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`"
section of the Yocto Project Development Tasks Manual. Reference
material for Wic is located in the
":doc:`../ref-manual/ref-kickstart`" chapter.
":doc:`/ref-manual/ref-kickstart`" chapter.
:term:`IMAGE_CLASSES`
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.
":ref:`sdk-manual/sdk-intro:the cross-development toolchain`"
section in the Yocto Project Overview and Concepts Manual. For
information on setting up a cross-development environment, see the
:doc:`../sdk-manual/index` manual.
:doc:`/sdk-manual/index` manual.
:term:`TOOLCHAIN_OUTPUTNAME`
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.
":ref:`sdk-manual/sdk-intro:the cross-development toolchain`"
section in the Yocto Project Overview and Concepts Manual. For
information on setting up a cross-development environment, see the
:doc:`../sdk-manual/index` manual.
:doc:`/sdk-manual/index` manual.
:term:`TOPDIR`
The top-level :term:`Build Directory`. BitBake
@@ -8737,7 +8737,7 @@ system and gives an overview of their function and contents.
image, see the
":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`"
section in the Yocto Project Development Tasks Manual. For details on
the kickstart file format, see the ":doc:`../ref-manual/ref-kickstart`" Chapter.
the kickstart file format, see the ":doc:`/ref-manual/ref-kickstart`" Chapter.
:term:`WKS_FILE_DEPENDS`
When placed in the recipe that builds your image, this variable lists
documentation/ref-manual/resources.rst
+9 -9
View File
@@ -125,33 +125,33 @@ Here is a list of resources you might find helpful:
guide to the BitBake tool. If you want information on BitBake, see
this manual.
- :doc:`../brief-yoctoprojectqs/index` *:* This
- :doc:`/brief-yoctoprojectqs/index` *:* This
short document lets you experience building an image using the Yocto
Project without having to understand any concepts or details.
- :doc:`../overview-manual/index` *:* This manual provides overview
- :doc:`/overview-manual/index` *:* This manual provides overview
and conceptual information about the Yocto Project.
- :doc:`../dev-manual/index` *:* This manual is a "how-to" guide
- :doc:`/dev-manual/index` *:* This manual is a "how-to" guide
that presents procedures useful to both application and system
developers who use the Yocto Project.
- :doc:`../sdk-manual/index` *manual :* This
- :doc:`/sdk-manual/index` *manual :* This
guide provides information that lets you get going with the standard
or extensible SDK. An SDK, with its cross-development toolchains,
allows you to develop projects inside or outside of the Yocto Project
environment.
- :doc:`../bsp-guide/bsp` *:* This guide defines the structure
- :doc:`/bsp-guide/bsp` *:* This guide defines the structure
for BSP components. Having a commonly understood structure encourages
standardization.
- :doc:`../kernel-dev/index` *:* This manual describes
- :doc:`/kernel-dev/index` *:* This manual describes
how to work with Linux Yocto kernels as well as provides a bit of
conceptual information on the construction of the Yocto Linux kernel
tree.
- :doc:`../ref-manual/index` *:* This
- :doc:`/ref-manual/index` *:* This
manual provides reference material such as variable, task, and class
descriptions.
@@ -161,11 +161,11 @@ Here is a list of resources you might find helpful:
which you can easily search for phrases and terms used in the Yocto
Project documentation set.
- :doc:`../profile-manual/index` *:* This manual presents a set of
- :doc:`/profile-manual/index` *:* This manual presents a set of
common and generally useful tracing and profiling schemes along with
their applications (as appropriate) to each tool.
- :doc:`../toaster-manual/index` *:* This manual
- :doc:`/toaster-manual/index` *:* This manual
introduces and describes how to set up and use Toaster. Toaster is an
Application Programming Interface (API) and web-based interface to
the :term:`OpenEmbedded Build System`, which uses