mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-06-04 14:09:47 +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/kernel-dev/kernel-dev-advanced.rst
+1 -1
View File
@@ -474,7 +474,7 @@ supported kernel type.
This section overviews the BSP description structure, the aggregation
concepts, and presents a detailed example using a BSP supported by the
Yocto Project (i.e. BeagleBone Board). For complete information on BSP
layer file hierarchy, see the :doc:`../bsp-guide/index`.
layer file hierarchy, see the :doc:`/bsp-guide/index`.
Description Overview
~~~~~~~~~~~~~~~~~~~~
documentation/kernel-dev/kernel-dev-common.rst
+2 -2
View File
@@ -21,7 +21,7 @@ Preparing the Build Host to Work on the Kernel
Before you can do any kernel development, you need to be sure your build
host is set up to use the Yocto Project. For information on how to get
set up, see the ":doc:`../dev-manual/dev-manual-start`" section in
set up, see the ":doc:`/dev-manual/dev-manual-start`" section in
the Yocto Project Development Tasks Manual. Part of preparing the system
is creating a local Git repository of the
:term:`Source Directory` (``poky``) on your system. Follow the steps in the
@@ -502,7 +502,7 @@ your layer in the following area:
.. note::
If you are working on a new machine Board Support Package (BSP), be
sure to refer to the :doc:`../bsp-guide/index`.
sure to refer to the :doc:`/bsp-guide/index`.
As an example, consider the following append file used by the BSPs in
``meta-yocto-bsp``:
documentation/kernel-dev/kernel-dev-intro.rst
+3 -3
View File
@@ -79,9 +79,9 @@ facilitate the process of working with the kernel recipes. If you find
you need some additional background, please be sure to review and
understand the following documentation:
- :doc:`../brief-yoctoprojectqs/index` document.
- :doc:`/brief-yoctoprojectqs/index` document.
- :doc:`../overview-manual/index`.
- :doc:`/overview-manual/index`.
- :ref:`devtool
workflow <sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow>`
@@ -111,7 +111,7 @@ general information and references for further information.
:align: center
1. *Set up Your Host Development System to Support Development Using the
Yocto Project*: See the ":doc:`../dev-manual/dev-manual-start`" section in
Yocto Project*: See the ":doc:`/dev-manual/dev-manual-start`" section in
the Yocto Project Development Tasks Manual for options on how to get
a build host ready to use the Yocto Project.