diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-30 11:00:01 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:34 +0100 |
commit | 283ed72d487ed78d4f8e0fcc17f635d6c212b7c6 (patch) | |
tree | ee9bc44a1a2789a729632f4c0c436257fa477b8e /documentation/kernel-dev | |
parent | 26c5622bb5551e1ad61db1c20890579dfb6b87c2 (diff) | |
download | poky-283ed72d487ed78d4f8e0fcc17f635d6c212b7c6.tar.gz |
sphinx: add links for Yocto project website
In DocBook, variables are used to create custom links (note that it is
not consistent everywhere, since some web addresses are still
hardcoded), such as YOCTO_HOME_URL, YOCTO_GIT_URL, YOCTO_WIKI_URL,
YOCTO_BUGS_URL and YOCTO_DL_URL..
In Sphinx they are replaced with extlinks.
(From yocto-docs rev: d25f3095a9d29a3355581d0743f27b2a423ad580)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev')
5 files changed, 17 insertions, 19 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.rst b/documentation/kernel-dev/kernel-dev-advanced.rst index 36a34ca28c..cef5966ca9 100644 --- a/documentation/kernel-dev/kernel-dev-advanced.rst +++ b/documentation/kernel-dev/kernel-dev-advanced.rst | |||
@@ -20,8 +20,8 @@ BSPs and Linux kernel types. | |||
20 | Kernel Metadata exists in many places. One area in the Yocto Project | 20 | Kernel Metadata exists in many places. One area in the Yocto Project |
21 | `Source Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the | 21 | `Source Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the |
22 | ``yocto-kernel-cache`` Git repository. You can find this repository | 22 | ``yocto-kernel-cache`` Git repository. You can find this repository |
23 | grouped under the "Yocto Linux Kernel" heading in the `Yocto Project | 23 | grouped under the "Yocto Linux Kernel" heading in the |
24 | Source Repositories <&YOCTO_GIT_URL;>`__. | 24 | :yocto_git:`Yocto Project Source Repositories <>`. |
25 | 25 | ||
26 | Kernel development tools ("kern-tools") exist also in the Yocto Project | 26 | Kernel development tools ("kern-tools") exist also in the Yocto Project |
27 | Source Repositories under the "Yocto Linux Kernel" heading in the | 27 | Source Repositories under the "Yocto Linux Kernel" heading in the |
@@ -188,7 +188,7 @@ either | |||
188 | :term:`FILESEXTRAPATHS` if | 188 | :term:`FILESEXTRAPATHS` if |
189 | you are creating Metadata in `recipe-space <#recipe-space-metadata>`__, | 189 | you are creating Metadata in `recipe-space <#recipe-space-metadata>`__, |
190 | or the top level of | 190 | or the top level of |
191 | ```yocto-kernel-cache`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache/tree/>`__ | 191 | :yocto_git:`yocto-kernel-cache </cgit/cgit.cgi/yocto-kernel-cache/tree/>` |
192 | if you are creating `Metadata outside of the | 192 | if you are creating `Metadata outside of the |
193 | recipe-space <#metadata-outside-the-recipe-space>`__. | 193 | recipe-space <#metadata-outside-the-recipe-space>`__. |
194 | 194 | ||
diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst index 813f4047e2..aa9f77de86 100644 --- a/documentation/kernel-dev/kernel-dev-common.rst +++ b/documentation/kernel-dev/kernel-dev-common.rst | |||
@@ -286,7 +286,7 @@ section: | |||
286 | 5. *Create a Local Copy of the Kernel Git Repository:* You can find Git | 286 | 5. *Create a Local Copy of the Kernel Git Repository:* You can find Git |
287 | repositories of supported Yocto Project kernels organized under | 287 | repositories of supported Yocto Project kernels organized under |
288 | "Yocto Linux Kernel" in the Yocto Project Source Repositories at | 288 | "Yocto Linux Kernel" in the Yocto Project Source Repositories at |
289 | ` <&YOCTO_GIT_URL;>`__. | 289 | :yocto_git:`/`. |
290 | 290 | ||
291 | For simplicity, it is recommended that you create your copy of the | 291 | For simplicity, it is recommended that you create your copy of the |
292 | kernel Git repository outside of the | 292 | kernel Git repository outside of the |
@@ -1404,7 +1404,7 @@ To help you use your own sources, the Yocto Project provides a | |||
1404 | linux-yocto custom recipe (``linux-yocto-custom.bb``) that uses | 1404 | linux-yocto custom recipe (``linux-yocto-custom.bb``) that uses |
1405 | ``kernel.org`` sources and the Yocto Project Linux kernel tools for | 1405 | ``kernel.org`` sources and the Yocto Project Linux kernel tools for |
1406 | managing kernel Metadata. You can find this recipe in the ``poky`` Git | 1406 | managing kernel Metadata. You can find this recipe in the ``poky`` Git |
1407 | repository of the Yocto Project `Source Repository <&YOCTO_GIT_URL;>`__ | 1407 | repository of the Yocto Project :yocto_git:`Source Repository <>` |
1408 | at: poky/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb | 1408 | at: poky/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb |
1409 | 1409 | ||
1410 | Here are some basic steps you can use to work with your own sources: | 1410 | Here are some basic steps you can use to work with your own sources: |
@@ -1535,7 +1535,7 @@ Linux kernel sources, if you need an external kernel module, the | |||
1535 | create your own out-of-tree Linux kernel module recipe. | 1535 | create your own out-of-tree Linux kernel module recipe. |
1536 | 1536 | ||
1537 | This template recipe is located in the ``poky`` Git repository of the | 1537 | This template recipe is located in the ``poky`` Git repository of the |
1538 | Yocto Project `Source Repository <&YOCTO_GIT_URL;>`__ at: | 1538 | Yocto Project :yocto_git:`Source Repository <>` at: |
1539 | poky/meta-skeleton/recipes-kernel/hello-mod/hello-mod_0.1.bb | 1539 | poky/meta-skeleton/recipes-kernel/hello-mod/hello-mod_0.1.bb |
1540 | 1540 | ||
1541 | To get started, copy this recipe to your layer and give it a meaningful | 1541 | To get started, copy this recipe to your layer and give it a meaningful |
diff --git a/documentation/kernel-dev/kernel-dev-concepts-appx.rst b/documentation/kernel-dev/kernel-dev-concepts-appx.rst index f65e960046..165cbb9aef 100644 --- a/documentation/kernel-dev/kernel-dev-concepts-appx.rst +++ b/documentation/kernel-dev/kernel-dev-concepts-appx.rst | |||
@@ -38,7 +38,7 @@ needs for targeted hardware. | |||
38 | 38 | ||
39 | You can find a web interface to the Yocto Linux kernels in the `Source | 39 | You can find a web interface to the Yocto Linux kernels in the `Source |
40 | Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ at | 40 | Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ at |
41 | ` <&YOCTO_GIT_URL;>`__. If you look at the interface, you will see to | 41 | :yocto_git:`/`. If you look at the interface, you will see to |
42 | the left a grouping of Git repositories titled "Yocto Linux Kernel". | 42 | the left a grouping of Git repositories titled "Yocto Linux Kernel". |
43 | Within this group, you will find several Linux Yocto kernels developed | 43 | Within this group, you will find several Linux Yocto kernels developed |
44 | and included with Yocto Project releases: | 44 | and included with Yocto Project releases: |
diff --git a/documentation/kernel-dev/kernel-dev-intro.rst b/documentation/kernel-dev/kernel-dev-intro.rst index 4da3af8dae..6708a6afe9 100644 --- a/documentation/kernel-dev/kernel-dev-intro.rst +++ b/documentation/kernel-dev/kernel-dev-intro.rst | |||
@@ -20,10 +20,10 @@ Project, and provides insight into how the Yocto Project team develops | |||
20 | and maintains Yocto Linux kernel Git repositories and Metadata. | 20 | and maintains Yocto Linux kernel Git repositories and Metadata. |
21 | 21 | ||
22 | Each Yocto Project release has a set of Yocto Linux kernel recipes, | 22 | Each Yocto Project release has a set of Yocto Linux kernel recipes, |
23 | whose Git repositories you can view in the Yocto `Source | 23 | whose Git repositories you can view in the Yocto |
24 | Repositories <&YOCTO_GIT_URL;>`__ under the "Yocto Linux Kernel" | 24 | :yocto_git:`Source Repositories <>` under the "Yocto Linux Kernel" |
25 | heading. New recipes for the release track the latest Linux kernel | 25 | heading. New recipes for the release track the latest Linux kernel |
26 | upstream developments from ` <http://www.kernel.org>`__ and introduce | 26 | upstream developments from http://www.kernel.org> and introduce |
27 | newly-supported platforms. Previous recipes in the release are refreshed | 27 | newly-supported platforms. Previous recipes in the release are refreshed |
28 | and supported for at least one additional Yocto Project release. As they | 28 | and supported for at least one additional Yocto Project release. As they |
29 | align, these previous releases are updated to include the latest from | 29 | align, these previous releases are updated to include the latest from |
diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.rst b/documentation/kernel-dev/kernel-dev-maint-appx.rst index c0c0bc260b..0b0cca14a7 100644 --- a/documentation/kernel-dev/kernel-dev-maint-appx.rst +++ b/documentation/kernel-dev/kernel-dev-maint-appx.rst | |||
@@ -10,7 +10,7 @@ Tree Construction | |||
10 | This section describes construction of the Yocto Project kernel source | 10 | This section describes construction of the Yocto Project kernel source |
11 | repositories as accomplished by the Yocto Project team to create Yocto | 11 | repositories as accomplished by the Yocto Project team to create Yocto |
12 | Linux kernel repositories. These kernel repositories are found under the | 12 | Linux kernel repositories. These kernel repositories are found under the |
13 | heading "Yocto Linux Kernel" at `YOCTO_GIT_URL <&YOCTO_GIT_URL;>`__ and | 13 | heading "Yocto Linux Kernel" at :yocto_git:`/` and |
14 | are shipped as part of a Yocto Project release. The team creates these | 14 | are shipped as part of a Yocto Project release. The team creates these |
15 | repositories by compiling and executing the set of feature descriptions | 15 | repositories by compiling and executing the set of feature descriptions |
16 | for every BSP and feature in the product. Those feature descriptions | 16 | for every BSP and feature in the product. Those feature descriptions |
@@ -80,7 +80,7 @@ to the kernel. | |||
80 | 80 | ||
81 | The following steps describe what happens when the Yocto Project Team | 81 | The following steps describe what happens when the Yocto Project Team |
82 | constructs the Yocto Project kernel source Git repository (or tree) | 82 | constructs the Yocto Project kernel source Git repository (or tree) |
83 | found at ` <&YOCTO_GIT_URL;>`__ given the introduction of a new | 83 | found at :yocto_git:`/` given the introduction of a new |
84 | top-level kernel feature or BSP. The following actions effectively | 84 | top-level kernel feature or BSP. The following actions effectively |
85 | provide the Metadata and create the tree that includes the new feature, | 85 | provide the Metadata and create the tree that includes the new feature, |
86 | patch, or BSP: | 86 | patch, or BSP: |
@@ -93,10 +93,9 @@ patch, or BSP: | |||
93 | located by searching these system directories: | 93 | located by searching these system directories: |
94 | 94 | ||
95 | - The in-tree kernel-cache directories, which are located in the | 95 | - The in-tree kernel-cache directories, which are located in the |
96 | ```yocto-kernel-cache`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache/tree/bsp>`__ | 96 | :yocto_git:`yocto-kernel-cache </cgit/cgit.cgi/yocto-kernel-cache/tree/bsp>` |
97 | repository organized under the "Yocto Linux Kernel" heading in the | 97 | repository organized under the "Yocto Linux Kernel" heading in the |
98 | `Yocto Project Source | 98 | :yocto_git:`Yocto Project Source Repositories <>`. |
99 | Repositories <http://git.yoctoproject.org/cgit/cgit.cgi>`__. | ||
100 | 99 | ||
101 | - Areas pointed to by ``SRC_URI`` statements found in kernel recipes | 100 | - Areas pointed to by ``SRC_URI`` statements found in kernel recipes |
102 | 101 | ||
@@ -143,8 +142,7 @@ specific to some target hardware. | |||
143 | as shipped with the Yocto Project release. Any add-ons and | 142 | as shipped with the Yocto Project release. Any add-ons and |
144 | configuration data are applied to the end of an existing branch. | 143 | configuration data are applied to the end of an existing branch. |
145 | The full repository generation that is found in the official Yocto | 144 | The full repository generation that is found in the official Yocto |
146 | Project kernel repositories at | 145 | Project kernel repositories at :yocto_git:`/` is the |
147 | `http://git.yoctoproject.org <&YOCTO_GIT_URL;>`__ is the | ||
148 | combination of all supported boards and configurations. | 146 | combination of all supported boards and configurations. |
149 | 147 | ||
150 | - The technique the Yocto Project team uses is flexible and allows | 148 | - The technique the Yocto Project team uses is flexible and allows |
@@ -152,12 +150,12 @@ specific to some target hardware. | |||
152 | patches specific to a deployment. Any additions to the kernel | 150 | patches specific to a deployment. Any additions to the kernel |
153 | become an integrated part of the branches. | 151 | become an integrated part of the branches. |
154 | 152 | ||
155 | - The full kernel tree that you see on ` <&YOCTO_GIT_URL;>`__ is | 153 | - The full kernel tree that you see on :yocto_git:`/` is |
156 | generated through repeating the above steps for all valid BSPs. | 154 | generated through repeating the above steps for all valid BSPs. |
157 | The end result is a branched, clean history tree that makes up the | 155 | The end result is a branched, clean history tree that makes up the |
158 | kernel for a given release. You can see the script (``kgit-scc``) | 156 | kernel for a given release. You can see the script (``kgit-scc``) |
159 | responsible for this in the | 157 | responsible for this in the |
160 | ```yocto-kernel-tools`` <&YOCTO_GIT_URL;/cgit.cgi/yocto-kernel-tools/tree/tools>`__ | 158 | :yocto_git:`yocto-kernel-tools </cgit.cgi/yocto-kernel-tools/tree/tools>` |
161 | repository. | 159 | repository. |
162 | 160 | ||
163 | - The steps used to construct the full kernel tree are the same | 161 | - The steps used to construct the full kernel tree are the same |