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/kernel-dev-maint-appx.rst | |
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/kernel-dev-maint-appx.rst')
-rw-r--r-- | documentation/kernel-dev/kernel-dev-maint-appx.rst | 16 |
1 files changed, 7 insertions, 9 deletions
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 |