summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-12-03 22:38:35 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-09 12:21:27 +0000
commit097d0c9f04353866302efebcdd0b497c2b89cabb (patch)
tree305ac5b0776eb37623a9be99a81bee3434a5e4a9 /documentation/kernel-dev
parentbd1789261122c25d62b8e8e7f7d5647249e8d8ff (diff)
downloadpoky-097d0c9f04353866302efebcdd0b497c2b89cabb.tar.gz
sphinx: use absolute paths for :doc: references
: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>
Diffstat (limited to 'documentation/kernel-dev')
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.rst2
-rw-r--r--documentation/kernel-dev/kernel-dev-common.rst4
-rw-r--r--documentation/kernel-dev/kernel-dev-intro.rst6
3 files changed, 6 insertions, 6 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.rst b/documentation/kernel-dev/kernel-dev-advanced.rst
index cc48343257..ddb31edca3 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.rst
+++ b/documentation/kernel-dev/kernel-dev-advanced.rst
@@ -474,7 +474,7 @@ supported kernel type.
474This section overviews the BSP description structure, the aggregation 474This section overviews the BSP description structure, the aggregation
475concepts, and presents a detailed example using a BSP supported by the 475concepts, and presents a detailed example using a BSP supported by the
476Yocto Project (i.e. BeagleBone Board). For complete information on BSP 476Yocto Project (i.e. BeagleBone Board). For complete information on BSP
477layer file hierarchy, see the :doc:`../bsp-guide/index`. 477layer file hierarchy, see the :doc:`/bsp-guide/index`.
478 478
479Description Overview 479Description Overview
480~~~~~~~~~~~~~~~~~~~~ 480~~~~~~~~~~~~~~~~~~~~
diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst
index c57025c67c..8e9bc27bf5 100644
--- a/documentation/kernel-dev/kernel-dev-common.rst
+++ b/documentation/kernel-dev/kernel-dev-common.rst
@@ -21,7 +21,7 @@ Preparing the Build Host to Work on the Kernel
21 21
22Before you can do any kernel development, you need to be sure your build 22Before you can do any kernel development, you need to be sure your build
23host is set up to use the Yocto Project. For information on how to get 23host is set up to use the Yocto Project. For information on how to get
24set up, see the ":doc:`../dev-manual/dev-manual-start`" section in 24set up, see the ":doc:`/dev-manual/dev-manual-start`" section in
25the Yocto Project Development Tasks Manual. Part of preparing the system 25the Yocto Project Development Tasks Manual. Part of preparing the system
26is creating a local Git repository of the 26is creating a local Git repository of the
27:term:`Source Directory` (``poky``) on your system. Follow the steps in the 27:term:`Source Directory` (``poky``) on your system. Follow the steps in the
@@ -502,7 +502,7 @@ your layer in the following area:
502.. note:: 502.. note::
503 503
504 If you are working on a new machine Board Support Package (BSP), be 504 If you are working on a new machine Board Support Package (BSP), be
505 sure to refer to the :doc:`../bsp-guide/index`. 505 sure to refer to the :doc:`/bsp-guide/index`.
506 506
507As an example, consider the following append file used by the BSPs in 507As an example, consider the following append file used by the BSPs in
508``meta-yocto-bsp``: 508``meta-yocto-bsp``:
diff --git a/documentation/kernel-dev/kernel-dev-intro.rst b/documentation/kernel-dev/kernel-dev-intro.rst
index a2961d864d..29d4516c53 100644
--- a/documentation/kernel-dev/kernel-dev-intro.rst
+++ b/documentation/kernel-dev/kernel-dev-intro.rst
@@ -79,9 +79,9 @@ facilitate the process of working with the kernel recipes. If you find
79you need some additional background, please be sure to review and 79you need some additional background, please be sure to review and
80understand the following documentation: 80understand the following documentation:
81 81
82- :doc:`../brief-yoctoprojectqs/index` document. 82- :doc:`/brief-yoctoprojectqs/index` document.
83 83
84- :doc:`../overview-manual/index`. 84- :doc:`/overview-manual/index`.
85 85
86- :ref:`devtool 86- :ref:`devtool
87 workflow <sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow>` 87 workflow <sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow>`
@@ -111,7 +111,7 @@ general information and references for further information.
111 :align: center 111 :align: center
112 112
1131. *Set up Your Host Development System to Support Development Using the 1131. *Set up Your Host Development System to Support Development Using the
114 Yocto Project*: See the ":doc:`../dev-manual/dev-manual-start`" section in 114 Yocto Project*: See the ":doc:`/dev-manual/dev-manual-start`" section in
115 the Yocto Project Development Tasks Manual for options on how to get 115 the Yocto Project Development Tasks Manual for options on how to get
116 a build host ready to use the Yocto Project. 116 a build host ready to use the Yocto Project.
117 117