summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-30 11:00:01 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:34 +0100
commit283ed72d487ed78d4f8e0fcc17f635d6c212b7c6 (patch)
treeee9bc44a1a2789a729632f4c0c436257fa477b8e /documentation
parent26c5622bb5551e1ad61db1c20890579dfb6b87c2 (diff)
downloadpoky-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')
-rw-r--r--documentation/boilerplate.rst6
-rw-r--r--documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst10
-rw-r--r--documentation/bsp-guide/bsp.rst40
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst35
-rw-r--r--documentation/dev-manual/dev-manual-intro.rst4
-rw-r--r--documentation/dev-manual/dev-manual-start.rst21
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.rst6
-rw-r--r--documentation/kernel-dev/kernel-dev-common.rst6
-rw-r--r--documentation/kernel-dev/kernel-dev-concepts-appx.rst2
-rw-r--r--documentation/kernel-dev/kernel-dev-intro.rst6
-rw-r--r--documentation/kernel-dev/kernel-dev-maint-appx.rst16
-rw-r--r--documentation/overview-manual/overview-manual-concepts.rst12
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.rst25
-rw-r--r--documentation/overview-manual/overview-manual-intro.rst4
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst15
-rw-r--r--documentation/ref-manual/faq.rst13
-rw-r--r--documentation/ref-manual/migration.rst4
-rw-r--r--documentation/ref-manual/ref-classes.rst2
-rw-r--r--documentation/ref-manual/ref-images.rst4
-rw-r--r--documentation/ref-manual/ref-system-requirements.rst10
-rw-r--r--documentation/ref-manual/ref-tasks.rst2
-rw-r--r--documentation/ref-manual/ref-terms.rst5
-rw-r--r--documentation/ref-manual/ref-variables.rst12
-rw-r--r--documentation/ref-manual/resources.rst20
-rw-r--r--documentation/sdk-manual/sdk-appendix-obtain.rst4
-rw-r--r--documentation/test-manual/test-manual-intro.rst2
-rw-r--r--documentation/toaster-manual/toaster-manual-reference.rst8
27 files changed, 140 insertions, 154 deletions
diff --git a/documentation/boilerplate.rst b/documentation/boilerplate.rst
index d9cb7a263d..a885f0eb10 100644
--- a/documentation/boilerplate.rst
+++ b/documentation/boilerplate.rst
@@ -14,7 +14,7 @@ Commons.
14 14
15 * This version of this *manual* is for the |YOCTO_DOC_VERSION| release of the 15 * This version of this *manual* is for the |YOCTO_DOC_VERSION| release of the
16 Yocto Project. To be sure you have the latest version of the manual for this 16 Yocto Project. To be sure you have the latest version of the manual for this
17 release, go to the :yocto_home:`Yocto Project documentation page <docs>` and 17 release, go to the :yocto_home:`Yocto Project documentation page </docs>` and
18 select the manual from that site. Manuals from the site are more up-to-date 18 select the manual from that site. Manuals from the site are more up-to-date
19 than manuals derived from the Yocto Project released TAR files. 19 than manuals derived from the Yocto Project released TAR files.
20 20
@@ -22,9 +22,9 @@ Commons.
22 might not be the one you want (e.g. the search might have returned a manual 22 might not be the one you want (e.g. the search might have returned a manual
23 much older than the Yocto Project version with which you are working). You 23 much older than the Yocto Project version with which you are working). You
24 can see all Yocto Project major releases by visiting the 24 can see all Yocto Project major releases by visiting the
25 :yocto_wiki:`Releases<wiki/Releases>` page. If you need a version of this 25 :yocto_wiki:`Releases</wiki/Releases>` page. If you need a version of this
26 manual for a different Yocto Project release, visit the :yocto_home:`Yocto 26 manual for a different Yocto Project release, visit the :yocto_home:`Yocto
27 Project documentation page<docs>` and select the manual set by using the 27 Project documentation page</docs>` and select the manual set by using the
28 "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. 28 "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus.
29 29
30 * To report any inaccuracies or problems with this (or any other Yocto 30 * To report any inaccuracies or problems with this (or any other Yocto
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
index 563c3f2d9a..8af70b4d46 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst
@@ -138,8 +138,8 @@ an entire Linux distribution, including the toolchain, from source.
138 - If you do not know your proxy settings, consult your local network 138 - If you do not know your proxy settings, consult your local network
139 infrastructure resources and get that information. A good starting 139 infrastructure resources and get that information. A good starting
140 point could also be to check your web browser settings. Finally, 140 point could also be to check your web browser settings. Finally,
141 you can find more information on the "`Working Behind a Network 141 you can find more information on the
142 Proxy <https://wiki.yoctoproject.org/wiki/Working_Behind_a_Network_Proxy>`__" 142 ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`"
143 page of the Yocto Project Wiki. 143 page of the Yocto Project Wiki.
144 144
1451. *Initialize the Build Environment:* From within the ``poky`` 1451. *Initialize the Build Environment:* From within the ``poky``
@@ -239,7 +239,7 @@ modular development and makes it easier to reuse the layer metadata.
239Follow these steps to add a hardware layer: 239Follow these steps to add a hardware layer:
240 240
2411. *Find a Layer:* Lots of hardware layers exist. The Yocto Project 2411. *Find a Layer:* Lots of hardware layers exist. The Yocto Project
242 `Source Repositories <&YOCTO_GIT_URL;>`__ has many hardware layers. 242 :yocto_git:`Source Repositories <>` has many hardware layers.
243 This example adds the 243 This example adds the
244 `meta-altera <https://github.com/kraj/meta-altera>`__ hardware layer. 244 `meta-altera <https://github.com/kraj/meta-altera>`__ hardware layer.
245 245
@@ -324,7 +324,7 @@ Now that you have experienced using the Yocto Project, you might be
324asking yourself "What now?" The Yocto Project has many sources of 324asking yourself "What now?" The Yocto Project has many sources of
325information including the website, wiki pages, and user manuals: 325information including the website, wiki pages, and user manuals:
326 326
327- *Website:* The `Yocto Project Website <&YOCTO_HOME_URL;>`__ provides 327- *Website:* The :yocto_home:`Yocto Project Website <>` provides
328 background information, the latest builds, breaking news, full 328 background information, the latest builds, breaking news, full
329 development documentation, and access to a rich Yocto Project 329 development documentation, and access to a rich Yocto Project
330 Development Community into which you can tap. 330 Development Community into which you can tap.
@@ -343,7 +343,7 @@ information including the website, wiki pages, and user manuals:
343 The manual also provides conceptual information for various aspects 343 The manual also provides conceptual information for various aspects
344 of the Yocto Project. 344 of the Yocto Project.
345 345
346- *Yocto Project Wiki:* The `Yocto Project Wiki <&YOCTO_WIKI_URL;>`__ 346- *Yocto Project Wiki:* The :yocto_wiki:`Yocto Project Wiki <>`
347 provides additional information on where to go next when ramping up 347 provides additional information on where to go next when ramping up
348 with the Yocto Project, release information, project planning, and QA 348 with the Yocto Project, release information, project planning, and QA
349 information. 349 information.
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 361951b592..9a12c942bc 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -43,7 +43,7 @@ To help understand the BSP layer concept, consider the BSPs that the
43Yocto Project supports and provides with each release. You can see the 43Yocto Project supports and provides with each release. You can see the
44layers in the `Yocto Project Source 44layers in the `Yocto Project Source
45Repositories <&YOCTO_DOCS_OM_URL;#yocto-project-repositories>`__ through 45Repositories <&YOCTO_DOCS_OM_URL;#yocto-project-repositories>`__ through
46a web interface at ` <&YOCTO_GIT_URL;>`__. If you go to that interface, 46a web interface at :yocto_git:`/`. If you go to that interface,
47you will find a list of repositories under "Yocto Metadata Layers". 47you will find a list of repositories under "Yocto Metadata Layers".
48 48
49.. note:: 49.. note::
@@ -270,7 +270,7 @@ meta-bsp_root_name/recipes-graphics/\*
270meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend 270meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend
271 271
272Below is an example of the Raspberry Pi BSP layer that is available from 272Below is an example of the Raspberry Pi BSP layer that is available from
273the `Source Respositories <&YOCTO_GIT_URL;>`__: 273the :yocto_git:`Source Respositories <>`:
274meta-raspberrypi/COPYING.MIT meta-raspberrypi/README.md 274meta-raspberrypi/COPYING.MIT meta-raspberrypi/README.md
275meta-raspberrypi/classes 275meta-raspberrypi/classes
276meta-raspberrypi/classes/sdcard_image-rpi.bbclass meta-raspberrypi/conf/ 276meta-raspberrypi/classes/sdcard_image-rpi.bbclass meta-raspberrypi/conf/
@@ -487,7 +487,7 @@ This optional area contains useful pre-built kernels and user-space
487filesystem images released with the BSP that are appropriate to the 487filesystem images released with the BSP that are appropriate to the
488target system. This directory typically contains graphical (e.g. Sato) 488target system. This directory typically contains graphical (e.g. Sato)
489and minimal live images when the BSP tarball has been created and made 489and minimal live images when the BSP tarball has been created and made
490available in the `Yocto Project <&YOCTO_HOME_URL;>`__ website. You can 490available in the :yocto_home:`Yocto Project <>` website. You can
491use these kernels and images to get a system running and quickly get 491use these kernels and images to get a system running and quickly get
492started on development tasks. 492started on development tasks.
493 493
@@ -871,13 +871,13 @@ Yocto Project:
871 ``meta-``\ bsp_root_name directory. This license covers the BSP 871 ``meta-``\ bsp_root_name directory. This license covers the BSP
872 Metadata as a whole. You must specify which license to use since no 872 Metadata as a whole. You must specify which license to use since no
873 default license exists when one is not specified. See the 873 default license exists when one is not specified. See the
874 ```COPYING.MIT`` <&YOCTO_GIT_URL;/cgit.cgi/meta-raspberrypi/tree/COPYING.MIT>`__ 874 :yocto_git:`COPYING.MIT </cgit.cgi/meta-raspberrypi/tree/COPYING.MIT>`
875 file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer 875 file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer
876 as an example. 876 as an example.
877 877
878- *README File:* You must include a ``README`` file in the 878- *README File:* You must include a ``README`` file in the
879 ``meta-``\ bsp_root_name directory. See the 879 ``meta-``\ bsp_root_name directory. See the
880 ```README.md`` <&YOCTO_GIT_URL;/cgit.cgi/meta-raspberrypi/tree/README.md>`__ 880 :yocto_git:`README.md </cgit.cgi/meta-raspberrypi/tree/README.md>`
881 file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer 881 file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer
882 as an example. 882 as an example.
883 883
@@ -976,8 +976,8 @@ Yocto Project:
976- *Use a Yocto Linux Kernel:* Kernel recipes in the BSP should be based 976- *Use a Yocto Linux Kernel:* Kernel recipes in the BSP should be based
977 on a Yocto Linux kernel. Basing your recipes on these kernels reduces 977 on a Yocto Linux kernel. Basing your recipes on these kernels reduces
978 the costs for maintaining the BSP and increases its scalability. See 978 the costs for maintaining the BSP and increases its scalability. See
979 the ``Yocto Linux Kernel`` category in the `Source 979 the ``Yocto Linux Kernel`` category in the
980 Repositories <&YOCTO_GIT_URL;>`__ for these kernels. 980 :yocto_git:`Source Repositories <>` for these kernels.
981 981
982Customizing a Recipe for a BSP 982Customizing a Recipe for a BSP
983============================== 983==============================
@@ -1067,7 +1067,7 @@ of the licensed version in the BSP recipe.
1067 1067
1068For cases where you can substitute a free component and still maintain 1068For cases where you can substitute a free component and still maintain
1069the system's functionality, the "DOWNLOADS" selection from the 1069the system's functionality, the "DOWNLOADS" selection from the
1070"SOFTWARE" tab on the `Yocto Project website <&YOCTO_HOME_URL;>`__ makes 1070"SOFTWARE" tab on the :yocto_home:`Yocto Project Website <>` makes
1071available de-featured BSPs that are completely free of any IP 1071available de-featured BSPs that are completely free of any IP
1072encumbrances. For these cases, you can use the substitution directly and 1072encumbrances. For these cases, you can use the substitution directly and
1073without any further licensing requirements. If present, these fully 1073without any further licensing requirements. If present, these fully
@@ -1114,8 +1114,8 @@ list describes them in order of preference:
1114 image with no change at all to the normal build process. 1114 image with no change at all to the normal build process.
1115 1115
11162. *Get a Pre-Built Version of the BSP:* You can get this type of BSP by 11162. *Get a Pre-Built Version of the BSP:* You can get this type of BSP by
1117 selecting the "DOWNLOADS" item from the "SOFTWARE" tab on the `Yocto 1117 selecting the "DOWNLOADS" item from the "SOFTWARE" tab on the
1118 Project website <&YOCTO_HOME_URL;>`__. You can download BSP tarballs 1118 :yocto_home:`Yocto Project website <>`. You can download BSP tarballs
1119 that contain proprietary components after agreeing to the licensing 1119 that contain proprietary components after agreeing to the licensing
1120 requirements of each of the individually encumbered packages as part 1120 requirements of each of the individually encumbered packages as part
1121 of the download process. Obtaining the BSP this way allows you to 1121 of the download process. Obtaining the BSP this way allows you to
@@ -1156,20 +1156,20 @@ Use these steps to create a BSP layer:
1156- *Create a Layer Configuration File:* Every layer needs a layer 1156- *Create a Layer Configuration File:* Every layer needs a layer
1157 configuration file. This configuration file establishes locations for 1157 configuration file. This configuration file establishes locations for
1158 the layer's recipes, priorities for the layer, and so forth. You can 1158 the layer's recipes, priorities for the layer, and so forth. You can
1159 find examples of ``layer.conf`` files in the Yocto Project `Source 1159 find examples of ``layer.conf`` files in the Yocto Project
1160 Repositories <&YOCTO_GIT_URL;>`__. To get examples of what you need 1160 :yocto_git:`Source Repositories <>`. To get examples of what you need
1161 in your configuration file, locate a layer (e.g. "meta-ti") and 1161 in your configuration file, locate a layer (e.g. "meta-ti") and
1162 examine the 1162 examine the
1163 ` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-ti/tree/conf/layer.conf>`__ 1163 :yocto_git:`local.conf </cgit/cgit.cgi/meta-ti/tree/conf/layer.conf>`
1164 file. 1164 file.
1165 1165
1166- *Create a Machine Configuration File:* Create a 1166- *Create a Machine Configuration File:* Create a
1167 ``conf/machine/``\ bsp_root_name\ ``.conf`` file. See 1167 ``conf/machine/``\ bsp_root_name\ ``.conf`` file. See
1168 ```meta-yocto-bsp/conf/machine`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf/machine>`__ 1168 :yocto_git:`meta-yocto-bsp/conf/machine </cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf/machine>`
1169 for sample bsp_root_name\ ``.conf`` files. Other samples such as 1169 for sample bsp_root_name\ ``.conf`` files. Other samples such as
1170 ```meta-ti`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-ti/tree/conf/machine>`__ 1170 :yocto_git:`meta-ti </cgit/cgit.cgi/meta-ti/tree/conf/machine>`
1171 and 1171 and
1172 ```meta-freescale`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-freescale/tree/conf/machine>`__ 1172 :yocto_git:`meta-freescale </cgit/cgit.cgi/meta-freescale/tree/conf/machine>`
1173 exist from other vendors that have more specific machine and tuning 1173 exist from other vendors that have more specific machine and tuning
1174 examples. 1174 examples.
1175 1175
@@ -1184,7 +1184,7 @@ Use these steps to create a BSP layer:
1184 1184
1185The remainder of this section provides a description of the Yocto 1185The remainder of this section provides a description of the Yocto
1186Project reference BSP for Beaglebone, which resides in the 1186Project reference BSP for Beaglebone, which resides in the
1187```meta-yocto-bsp`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp>`__ 1187:yocto_git:`meta-yocto-bsp </cgit/cgit.cgi/poky/tree/meta-yocto-bsp>`
1188layer. 1188layer.
1189 1189
1190BSP Layer Configuration Example 1190BSP Layer Configuration Example
@@ -1199,8 +1199,8 @@ BBFILE_COLLECTIONS += "yoctobsp" BBFILE_PATTERN_yoctobsp =
1199"^${LAYERDIR}/" BBFILE_PRIORITY_yoctobsp = "5" LAYERVERSION_yoctobsp = 1199"^${LAYERDIR}/" BBFILE_PRIORITY_yoctobsp = "5" LAYERVERSION_yoctobsp =
1200"4" LAYERSERIES_COMPAT_yoctobsp = "DISTRO_NAME_NO_CAP" The variables 1200"4" LAYERSERIES_COMPAT_yoctobsp = "DISTRO_NAME_NO_CAP" The variables
1201used in this file configure the layer. A good way to learn about layer 1201used in this file configure the layer. A good way to learn about layer
1202configuration files is to examine various files for BSP from the `Source 1202configuration files is to examine various files for BSP from the
1203Repositories <&YOCTO_GIT_URL;>`__. 1203:yocto_git:`Source Repositories <>`.
1204 1204
1205For a detailed description of this particular layer configuration file, 1205For a detailed description of this particular layer configuration file,
1206see "`step 3 <&YOCTO_DOCS_DEV_URL;#dev-layer-config-file-description>`__ 1206see "`step 3 <&YOCTO_DOCS_DEV_URL;#dev-layer-config-file-description>`__
@@ -1409,7 +1409,7 @@ PREFERRED_VERSION_linux-yocto ?= "5.0%" The
1409metadata used to build the kernel. In this case, a kernel append file 1409metadata used to build the kernel. In this case, a kernel append file
1410(i.e. ``linux-yocto_5.0.bbappend``) is used to override an established 1410(i.e. ``linux-yocto_5.0.bbappend``) is used to override an established
1411kernel recipe (i.e. ``linux-yocto_5.0.bb``), which is located in 1411kernel recipe (i.e. ``linux-yocto_5.0.bb``), which is located in
1412` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/recipes-kernel/linux>`__. 1412https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/recipes-kernel/linux.
1413 1413
1414Following is the contents of the append file: KBRANCH_genericx86 = 1414Following is the contents of the append file: KBRANCH_genericx86 =
1415"v5.0/standard/base" KBRANCH_genericx86-64 = "v5.0/standard/base" 1415"v5.0/standard/base" KBRANCH_genericx86-64 = "v5.0/standard/base"
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index 29a94b9a84..0703f3ebc8 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -68,8 +68,7 @@ Follow these general steps to create your layer without using tools:
68 ``conf`` directory and then modify the file as needed. 68 ``conf`` directory and then modify the file as needed.
69 69
70 The ``meta-yocto-bsp/conf/layer.conf`` file in the Yocto Project 70 The ``meta-yocto-bsp/conf/layer.conf`` file in the Yocto Project
71 `Source 71 :yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf>`
72 Repositories <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf>`__
73 demonstrates the required syntax. For your layer, you need to replace 72 demonstrates the required syntax. For your layer, you need to replace
74 "yoctobsp" with a unique identifier for your layer (e.g. "machinexyz" 73 "yoctobsp" with a unique identifier for your layer (e.g. "machinexyz"
75 for a layer named "meta-machinexyz"): # We have a conf and classes 74 for a layer named "meta-machinexyz"): # We have a conf and classes
@@ -120,7 +119,7 @@ Follow these general steps to create your layer without using tools:
120 Lists all layers on which this layer depends (if any). 119 Lists all layers on which this layer depends (if any).
121 120
122 - :term:`LAYERSERIES_COMPAT`: 121 - :term:`LAYERSERIES_COMPAT`:
123 Lists the `Yocto Project <&YOCTO_WIKI_URL;/wiki/Releases>`__ 122 Lists the :yocto_wiki:`Yocto Project </wiki/Releases>`
124 releases for which the current version is compatible. This 123 releases for which the current version is compatible. This
125 variable is a good way to indicate if your particular layer is 124 variable is a good way to indicate if your particular layer is
126 current. 125 current.
@@ -4001,9 +4000,9 @@ your tunings to best consider build times and package feed maintenance.
4001 higher levels noted earlier can be useful. For example, consider how 4000 higher levels noted earlier can be useful. For example, consider how
4002 NXP (formerly Freescale) allows for the easy reuse of binary packages 4001 NXP (formerly Freescale) allows for the easy reuse of binary packages
4003 in their layer 4002 in their layer
4004 ```meta-freescale`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-freescale/>`__. 4003 :yocto_git:`meta-freescale </cgit/cgit.cgi/meta-freescale/>`.
4005 In this example, the 4004 In this example, the
4006 ```fsl-dynamic-packagearch`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-freescale/tree/classes/fsl-dynamic-packagearch.bbclass>`__ 4005 :yocto_git:`fsl-dynamic-packagearch </cgit/cgit.cgi/meta-freescale/tree/classes/fsl-dynamic-packagearch.bbclass>`
4007 class shares GPU packages for i.MX53 boards because all boards share 4006 class shares GPU packages for i.MX53 boards because all boards share
4008 the AMD GPU. The i.MX6-based boards can do the same because all 4007 the AMD GPU. The i.MX6-based boards can do the same because all
4009 boards share the Vivante GPU. This class inspects the BitBake 4008 boards share the Vivante GPU. This class inspects the BitBake
@@ -5058,7 +5057,7 @@ partition.
5058Source plugins are subclasses defined in plugin files. As shipped, the 5057Source plugins are subclasses defined in plugin files. As shipped, the
5059Yocto Project provides several plugin files. You can see the source 5058Yocto Project provides several plugin files. You can see the source
5060plugin files that ship with the Yocto Project 5059plugin files that ship with the Yocto Project
5061`here <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/scripts/lib/wic/plugins/source>`__. 5060:yocto_git:`here </cgit/cgit.cgi/poky/tree/scripts/lib/wic/plugins/source>`.
5062Each of these plugin files contains source plugins that are designed to 5061Each of these plugin files contains source plugins that are designed to
5063populate a specific Wic image partition. 5062populate a specific Wic image partition.
5064 5063
@@ -5591,8 +5590,8 @@ Tools for Hardening Your Image
5591------------------------------ 5590------------------------------
5592 5591
5593The Yocto Project provides tools for making your image more secure. You 5592The Yocto Project provides tools for making your image more secure. You
5594can find these tools in the ``meta-security`` layer of the `Yocto 5593can find these tools in the ``meta-security`` layer of the
5595Project Source Repositories <&YOCTO_GIT_URL;>`__. 5594:yocto_git:`Yocto Project Source Repositories <>`.
5596 5595
5597Creating Your Own Distribution 5596Creating Your Own Distribution
5598============================== 5597==============================
@@ -5872,7 +5871,7 @@ the following:
5872 build system uses this string to help define the value of ``PV`` when 5871 build system uses this string to help define the value of ``PV`` when
5873 the source code revision needs to be included in it. 5872 the source code revision needs to be included in it.
5874 5873
5875- `PR Service <https://wiki.yoctoproject.org/wiki/PR_Service>`__: A 5874- :yocto_wiki:`PR Service </wiki/PR_Service>`: A
5876 network-based service that helps automate keeping package feeds 5875 network-based service that helps automate keeping package feeds
5877 compatible with existing package manager applications such as RPM, 5876 compatible with existing package manager applications such as RPM,
5878 APT, and OPKG. 5877 APT, and OPKG.
@@ -6574,7 +6573,7 @@ testname where the result can be ``PASS``, ``FAIL``, or ``SKIP``, and
6574the testname can be any identifying string. 6573the testname can be any identifying string.
6575 6574
6576For a list of Yocto Project recipes that are already enabled with ptest, 6575For a list of Yocto Project recipes that are already enabled with ptest,
6577see the `Ptest <https://wiki.yoctoproject.org/wiki/Ptest>`__ wiki page. 6576see the :yocto_wiki:`Ptest </wiki/Ptest>` wiki page.
6578 6577
6579.. note:: 6578.. note::
6580 6579
@@ -9209,10 +9208,9 @@ Here are some other tips that you might find useful:
9209 indicate that the documentation should be extended or improved. In 9208 indicate that the documentation should be extended or improved. In
9210 such cases, consider filing a documentation bug using the Yocto 9209 such cases, consider filing a documentation bug using the Yocto
9211 Project implementation of 9210 Project implementation of
9212 `Bugzilla <https://bugzilla.yoctoproject.org/>`__. For information on 9211 :yocto_bugs:`Bugzilla <>`. For information on
9213 how to submit a bug against the Yocto Project, see the Yocto Project 9212 how to submit a bug against the Yocto Project, see the Yocto Project
9214 Bugzilla `wiki 9213 Bugzilla :yocto_wiki:`wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`
9215 page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__
9216 and the "`Submitting a Defect Against the Yocto 9214 and the "`Submitting a Defect Against the Yocto
9217 Project <#submitting-a-defect-against-the-yocto-project>`__" section. 9215 Project <#submitting-a-defect-against-the-yocto-project>`__" section.
9218 9216
@@ -9241,13 +9239,12 @@ against the Yocto Project. For additional information on this
9241implementation of Bugzilla see the "`Yocto Project 9239implementation of Bugzilla see the "`Yocto Project
9242Bugzilla <&YOCTO_DOCS_REF_URL;#resources-bugtracker>`__" section in the 9240Bugzilla <&YOCTO_DOCS_REF_URL;#resources-bugtracker>`__" section in the
9243Yocto Project Reference Manual. For more detail on any of the following 9241Yocto Project Reference Manual. For more detail on any of the following
9244steps, see the Yocto Project `Bugzilla wiki 9242steps, see the Yocto Project
9245page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__. 9243:yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`.
9246 9244
9247Use the following general steps to submit a bug" 9245Use the following general steps to submit a bug"
9248 9246
92491. Open the Yocto Project implementation of 92471. Open the Yocto Project implementation of :yocto_bugs:`Bugzilla <>`.
9250 `Bugzilla <&YOCTO_BUGZILLA_URL;>`__.
9251 9248
92522. Click "File a Bug" to enter a new bug. 92492. Click "File a Bug" to enter a new bug.
9253 9250
@@ -9365,8 +9362,8 @@ concepts on working in the Yocto Project development environment.
9365Two commonly used testing repositories exist for OpenEmbedded-Core: 9362Two commonly used testing repositories exist for OpenEmbedded-Core:
9366 9363
9367- *"ross/mut" branch:* The "mut" (master-under-test) tree exists in the 9364- *"ross/mut" branch:* The "mut" (master-under-test) tree exists in the
9368 ``poky-contrib`` repository in the `Yocto Project source 9365 ``poky-contrib`` repository in the
9369 repositories <&YOCTO_GIT_URL;>`__. 9366 :yocto_git:`Yocto Project source repositories <>`.
9370 9367
9371- *"master-next" branch:* This branch is part of the main "poky" 9368- *"master-next" branch:* This branch is part of the main "poky"
9372 repository in the Yocto Project source repositories. 9369 repository in the Yocto Project source repositories.
diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/dev-manual-intro.rst
index 492d3db82a..1dc552c750 100644
--- a/documentation/dev-manual/dev-manual-intro.rst
+++ b/documentation/dev-manual/dev-manual-intro.rst
@@ -53,8 +53,8 @@ Other Information
53 53
54Because this manual presents information for many different topics, 54Because this manual presents information for many different topics,
55supplemental information is recommended for full comprehension. For 55supplemental information is recommended for full comprehension. For
56introductory information on the Yocto Project, see the `Yocto Project 56introductory information on the Yocto Project, see the
57Website <&YOCTO_HOME_URL;>`__. If you want to build an image with no 57:yocto_home:`Yocto Project Website <>`. If you want to build an image with no
58knowledge of Yocto Project as a way of quickly testing it out, see the 58knowledge of Yocto Project as a way of quickly testing it out, see the
59`Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document. 59`Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document.
60 60
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst
index 81fa7847e6..884d1286ef 100644
--- a/documentation/dev-manual/dev-manual-start.rst
+++ b/documentation/dev-manual/dev-manual-start.rst
@@ -92,7 +92,7 @@ particular working environment and set of practices.
92 92
93 It is relatively easy to set up Git services and create 93 It is relatively easy to set up Git services and create
94 infrastructure like 94 infrastructure like
95 `http://git.yoctoproject.org <&YOCTO_GIT_URL;>`__, which is based on 95 :yocto_git:`http://git.yoctoproject.org <>`, which is based on
96 server software called ``gitolite`` with ``cgit`` being used to 96 server software called ``gitolite`` with ``cgit`` being used to
97 generate the web interface that lets you view the repositories. The 97 generate the web interface that lets you view the repositories. The
98 ``gitolite`` software identifies users using SSH keys and allows 98 ``gitolite`` software identifies users using SSH keys and allows
@@ -322,8 +322,7 @@ Project Build Host:
322 validation and their status, see the "`Supported Linux 322 validation and their status, see the "`Supported Linux
323 Distributions <&YOCTO_DOCS_REF_URL;#detailed-supported-distros>`__" 323 Distributions <&YOCTO_DOCS_REF_URL;#detailed-supported-distros>`__"
324 section in the Yocto Project Reference Manual and the wiki page at 324 section in the Yocto Project Reference Manual and the wiki page at
325 `Distribution 325 :yocto_wiki:`Distribution Support </wiki/Distribution_Support>`.
326 Support <&YOCTO_WIKI_URL;/wiki/Distribution_Support>`__.
327 326
3282. *Have Enough Free Memory:* Your system should have at least 50 Gbytes 3272. *Have Enough Free Memory:* Your system should have at least 50 Gbytes
329 of free disk space for building images. 328 of free disk space for building images.
@@ -598,14 +597,14 @@ Working from a copy of the upstream Yocto Project `Source
598Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the 597Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the
599preferred method for obtaining and using a Yocto Project release. You 598preferred method for obtaining and using a Yocto Project release. You
600can view the Yocto Project Source Repositories at 599can view the Yocto Project Source Repositories at
601` <&YOCTO_GIT_URL;>`__. In particular, you can find the ``poky`` 600:yocto_git:`/`. In particular, you can find the ``poky``
602repository at ` <http://git.yoctoproject.org/cgit/cgit.cgi/poky/>`__. 601repository at :yocto_git:`/cgit.cgi/poky`.
603 602
604Use the following procedure to locate the latest upstream copy of the 603Use the following procedure to locate the latest upstream copy of the
605``poky`` Git repository: 604``poky`` Git repository:
606 605
6071. *Access Repositories:* Open a browser and go to 6061. *Access Repositories:* Open a browser and go to
608 ` <&YOCTO_GIT_URL;>`__ to access the GUI-based interface into the 607 :yocto_git:`/` to access the GUI-based interface into the
609 Yocto Project source repositories. 608 Yocto Project source repositories.
610 609
6112. *Select the Repository:* Click on the repository in which you are 6102. *Select the Repository:* Click on the repository in which you are
@@ -614,7 +613,7 @@ Use the following procedure to locate the latest upstream copy of the
6143. *Find the URL Used to Clone the Repository:* At the bottom of the 6133. *Find the URL Used to Clone the Repository:* At the bottom of the
615 page, note the URL used to 614 page, note the URL used to
616 `clone <&YOCTO_DOCS_OM_URL;#git-commands-clone>`__ that repository 615 `clone <&YOCTO_DOCS_OM_URL;#git-commands-clone>`__ that repository
617 (e.g. ``YOCTO_GIT_URL/poky``). 616 (e.g. :yocto_git:`/git/poky`).
618 617
619 .. note:: 618 .. note::
620 619
@@ -642,7 +641,7 @@ of a given component.
642Follow these steps to locate and download a particular tarball: 641Follow these steps to locate and download a particular tarball:
643 642
6441. *Access the Index of Releases:* Open a browser and go to 6431. *Access the Index of Releases:* Open a browser and go to
645 ` <&YOCTO_DL_URL;/releases>`__ to access the Index of Releases. The 644 :yocto_dl:`Index of Releases <releases>`. The
646 list represents released components (e.g. ``bitbake``, ``sato``, and 645 list represents released components (e.g. ``bitbake``, ``sato``, and
647 so on). 646 so on).
648 647
@@ -670,7 +669,7 @@ Follow these steps to locate and download a particular tarball:
670Using the Downloads Page 669Using the Downloads Page
671------------------------ 670------------------------
672 671
673The `Yocto Project Website <&YOCTO_HOME_URL;>`__ uses a "DOWNLOADS" page 672The :yocto_home:`Yocto Project Website <>` uses a "DOWNLOADS" page
674from which you can locate and download tarballs of any Yocto Project 673from which you can locate and download tarballs of any Yocto Project
675release. Rather than Git repositories, these files represent snapshot 674release. Rather than Git repositories, these files represent snapshot
676tarballs similar to the tarballs located in the Index of Releases 675tarballs similar to the tarballs located in the Index of Releases
@@ -684,8 +683,8 @@ Releases <#accessing-index-of-releases>`__" section.
684 repository. The procedure in this section exists should you desire a 683 repository. The procedure in this section exists should you desire a
685 tarball snapshot of any given component. 684 tarball snapshot of any given component.
686 685
6871. *Go to the Yocto Project Website:* Open The `Yocto Project 6861. *Go to the Yocto Project Website:* Open The
688 Website <&YOCTO_HOME_URL;>`__ in your browser. 687 :yocto_home:`Yocto Project Website <>` in your browser.
689 688
6902. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the 6892. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the
691 pull-down "SOFTWARE" tab menu near the top of the page. 690 pull-down "SOFTWARE" tab menu near the top of the page.
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.
20Kernel Metadata exists in many places. One area in the Yocto Project 20Kernel 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
23grouped under the "Yocto Linux Kernel" heading in the `Yocto Project 23grouped under the "Yocto Linux Kernel" heading in the
24Source Repositories <&YOCTO_GIT_URL;>`__. 24:yocto_git:`Yocto Project Source Repositories <>`.
25 25
26Kernel development tools ("kern-tools") exist also in the Yocto Project 26Kernel development tools ("kern-tools") exist also in the Yocto Project
27Source Repositories under the "Yocto Linux Kernel" heading in the 27Source Repositories under the "Yocto Linux Kernel" heading in the
@@ -188,7 +188,7 @@ either
188:term:`FILESEXTRAPATHS` if 188:term:`FILESEXTRAPATHS` if
189you are creating Metadata in `recipe-space <#recipe-space-metadata>`__, 189you are creating Metadata in `recipe-space <#recipe-space-metadata>`__,
190or the top level of 190or 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/>`
192if you are creating `Metadata outside of the 192if you are creating `Metadata outside of the
193recipe-space <#metadata-outside-the-recipe-space>`__. 193recipe-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:
2865. *Create a Local Copy of the Kernel Git Repository:* You can find Git 2865. *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
1404linux-yocto custom recipe (``linux-yocto-custom.bb``) that uses 1404linux-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
1406managing kernel Metadata. You can find this recipe in the ``poky`` Git 1406managing kernel Metadata. You can find this recipe in the ``poky`` Git
1407repository of the Yocto Project `Source Repository <&YOCTO_GIT_URL;>`__ 1407repository of the Yocto Project :yocto_git:`Source Repository <>`
1408at: poky/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb 1408at: poky/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb
1409 1409
1410Here are some basic steps you can use to work with your own sources: 1410Here 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
1535create your own out-of-tree Linux kernel module recipe. 1535create your own out-of-tree Linux kernel module recipe.
1536 1536
1537This template recipe is located in the ``poky`` Git repository of the 1537This template recipe is located in the ``poky`` Git repository of the
1538Yocto Project `Source Repository <&YOCTO_GIT_URL;>`__ at: 1538Yocto Project :yocto_git:`Source Repository <>` at:
1539poky/meta-skeleton/recipes-kernel/hello-mod/hello-mod_0.1.bb 1539poky/meta-skeleton/recipes-kernel/hello-mod/hello-mod_0.1.bb
1540 1540
1541To get started, copy this recipe to your layer and give it a meaningful 1541To 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
39You can find a web interface to the Yocto Linux kernels in the `Source 39You can find a web interface to the Yocto Linux kernels in the `Source
40Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ at 40Repositories <&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
42the left a grouping of Git repositories titled "Yocto Linux Kernel". 42the left a grouping of Git repositories titled "Yocto Linux Kernel".
43Within this group, you will find several Linux Yocto kernels developed 43Within this group, you will find several Linux Yocto kernels developed
44and included with Yocto Project releases: 44and 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
20and maintains Yocto Linux kernel Git repositories and Metadata. 20and maintains Yocto Linux kernel Git repositories and Metadata.
21 21
22Each Yocto Project release has a set of Yocto Linux kernel recipes, 22Each Yocto Project release has a set of Yocto Linux kernel recipes,
23whose Git repositories you can view in the Yocto `Source 23whose Git repositories you can view in the Yocto
24Repositories <&YOCTO_GIT_URL;>`__ under the "Yocto Linux Kernel" 24:yocto_git:`Source Repositories <>` under the "Yocto Linux Kernel"
25heading. New recipes for the release track the latest Linux kernel 25heading. New recipes for the release track the latest Linux kernel
26upstream developments from ` <http://www.kernel.org>`__ and introduce 26upstream developments from http://www.kernel.org> and introduce
27newly-supported platforms. Previous recipes in the release are refreshed 27newly-supported platforms. Previous recipes in the release are refreshed
28and supported for at least one additional Yocto Project release. As they 28and supported for at least one additional Yocto Project release. As they
29align, these previous releases are updated to include the latest from 29align, 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
10This section describes construction of the Yocto Project kernel source 10This section describes construction of the Yocto Project kernel source
11repositories as accomplished by the Yocto Project team to create Yocto 11repositories as accomplished by the Yocto Project team to create Yocto
12Linux kernel repositories. These kernel repositories are found under the 12Linux kernel repositories. These kernel repositories are found under the
13heading "Yocto Linux Kernel" at `YOCTO_GIT_URL <&YOCTO_GIT_URL;>`__ and 13heading "Yocto Linux Kernel" at :yocto_git:`/` and
14are shipped as part of a Yocto Project release. The team creates these 14are shipped as part of a Yocto Project release. The team creates these
15repositories by compiling and executing the set of feature descriptions 15repositories by compiling and executing the set of feature descriptions
16for every BSP and feature in the product. Those feature descriptions 16for every BSP and feature in the product. Those feature descriptions
@@ -80,7 +80,7 @@ to the kernel.
80 80
81The following steps describe what happens when the Yocto Project Team 81The following steps describe what happens when the Yocto Project Team
82constructs the Yocto Project kernel source Git repository (or tree) 82constructs the Yocto Project kernel source Git repository (or tree)
83found at ` <&YOCTO_GIT_URL;>`__ given the introduction of a new 83found at :yocto_git:`/` given the introduction of a new
84top-level kernel feature or BSP. The following actions effectively 84top-level kernel feature or BSP. The following actions effectively
85provide the Metadata and create the tree that includes the new feature, 85provide the Metadata and create the tree that includes the new feature,
86patch, or BSP: 86patch, 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
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst
index 9764b25b6d..978c2b0b6f 100644
--- a/documentation/overview-manual/overview-manual-concepts.rst
+++ b/documentation/overview-manual/overview-manual-concepts.rst
@@ -277,7 +277,7 @@ The ``local.conf`` file provides many basic variables that define a
277build environment. Here is a list of a few. To see the default 277build environment. Here is a list of a few. To see the default
278configurations in a ``local.conf`` file created by the build environment 278configurations in a ``local.conf`` file created by the build environment
279script, see the 279script, see the
280```local.conf.sample`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample>`__ 280:yocto_git:`local.conf.sample </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample>`
281in the ``meta-poky`` layer: 281in the ``meta-poky`` layer:
282 282
283- *Target Machine Selection:* Controlled by the 283- *Target Machine Selection:* Controlled by the
@@ -397,17 +397,17 @@ figure <#general-workflow-figure>`__:
397 configurations. This type of information is specific to a particular 397 configurations. This type of information is specific to a particular
398 target architecture. A good example of a BSP layer from the `Poky 398 target architecture. A good example of a BSP layer from the `Poky
399 Reference Distribution <#gs-reference-distribution-poky>`__ is the 399 Reference Distribution <#gs-reference-distribution-poky>`__ is the
400 ```meta-yocto-bsp`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp>`__ 400 :yocto_git:`meta-yocto-bsp </cgit/cgit.cgi/poky/tree/meta-yocto-bsp>`
401 layer. 401 layer.
402 402
403- *Policy Configuration:* Distribution Layers (i.e. "Distro Layer" in 403- *Policy Configuration:* Distribution Layers (i.e. "Distro Layer" in
404 the following figure) providing top-level or general policies for the 404 the following figure) providing top-level or general policies for the
405 images or SDKs being built for a particular distribution. For 405 images or SDKs being built for a particular distribution. For
406 example, in the Poky Reference Distribution the distro layer is the 406 example, in the Poky Reference Distribution the distro layer is the
407 ```meta-poky`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky>`__ 407 :yocto_git:`meta-poky </cgit/cgit.cgi/poky/tree/meta-poky>`
408 layer. Within the distro layer is a ``conf/distro`` directory that 408 layer. Within the distro layer is a ``conf/distro`` directory that
409 contains distro configuration files (e.g. 409 contains distro configuration files (e.g.
410 ```poky.conf`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/distro/poky.conf>`__ 410 :yocto_git:`poky.conf </cgit/cgit.cgi/poky/tree/meta-poky/conf/distro/poky.conf>`
411 that contain many policy configurations for the Poky distribution. 411 that contain many policy configurations for the Poky distribution.
412 412
413The following figure shows an expanded representation of these three 413The following figure shows an expanded representation of these three
@@ -901,7 +901,7 @@ This step in the build process consists of the following tasks:
901 variables. For information on how this variable works within that 901 variables. For information on how this variable works within that
902 class, see the 902 class, see the
903 :ref:`autotools <ref-classes-autotools>` class 903 :ref:`autotools <ref-classes-autotools>` class
904 `here <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/autotools.bbclass>`__. 904 :yocto_git:`here </cgit/cgit.cgi/poky/tree/meta/classes/autotools.bbclass>`.
905 905
906- *``do_compile``*: Once a configuration task has been satisfied, 906- *``do_compile``*: Once a configuration task has been satisfied,
907 BitBake compiles the source using the 907 BitBake compiles the source using the
@@ -981,7 +981,7 @@ The :term:`FILES` variable defines the
981files that go into each package in 981files that go into each package in
982:term:`PACKAGES`. If you want 982:term:`PACKAGES`. If you want
983details on how this is accomplished, you can look at 983details on how this is accomplished, you can look at
984```package.bbclass`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/package.bbclass>`__. 984:yocto_git:`package.bbclass </cgit/cgit.cgi/poky/tree/meta/classes/package.bbclass>`.
985 985
986Depending on the type of packages being created (RPM, DEB, or IPK), the 986Depending on the type of packages being created (RPM, DEB, or IPK), the
987:ref:`do_package_write_* <ref-tasks-package_write_deb>` 987:ref:`do_package_write_* <ref-tasks-package_write_deb>`
diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst
index 82562bf995..65ad1d1206 100644
--- a/documentation/overview-manual/overview-manual-development-environment.rst
+++ b/documentation/overview-manual/overview-manual-development-environment.rst
@@ -143,7 +143,7 @@ Yocto Project Source Repositories
143================================= 143=================================
144 144
145The Yocto Project team maintains complete source repositories for all 145The Yocto Project team maintains complete source repositories for all
146Yocto Project files at ` <&YOCTO_GIT_URL;>`__. This web-based source 146Yocto Project files at :yocto_git:`/`. This web-based source
147code browser is organized into categories by function such as IDE 147code browser is organized into categories by function such as IDE
148Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. From the 148Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. From the
149interface, you can click on any particular item in the "Name" column and 149interface, you can click on any particular item in the "Name" column and
@@ -155,7 +155,7 @@ history, and ultimately enhance the Yocto Project's tools, Board Support
155Packages, and so forth. 155Packages, and so forth.
156 156
157For any supported release of Yocto Project, you can also go to the 157For any supported release of Yocto Project, you can also go to the
158`Yocto Project Website <&YOCTO_HOME_URL;>`__ and select the "DOWNLOADS" 158:yocto_home:`Yocto Project Website <>` and select the "DOWNLOADS"
159item from the "SOFTWARE" menu and get a released tarball of the ``poky`` 159item from the "SOFTWARE" menu and get a released tarball of the ``poky``
160repository, any supported BSP tarball, or Yocto Project tools. Unpacking 160repository, any supported BSP tarball, or Yocto Project tools. Unpacking
161these tarballs gives you a snapshot of the released files. 161these tarballs gives you a snapshot of the released files.
@@ -176,7 +176,7 @@ these tarballs gives you a snapshot of the released files.
176In summary, here is where you can get the project files needed for 176In summary, here is where you can get the project files needed for
177development: 177development:
178 178
179- `Source Repositories: <&YOCTO_GIT_URL;>`__ This area contains IDE 179- :yocto_git:`Source Repositories: <>` This area contains IDE
180 Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and 180 Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and
181 Yocto Metadata Layers. You can create local copies of Git 181 Yocto Metadata Layers. You can create local copies of Git
182 repositories for each of these areas. 182 repositories for each of these areas.
@@ -189,7 +189,7 @@ development:
189 Repositories <&YOCTO_DOCS_DEV_URL;#accessing-source-repositories>`__" 189 Repositories <&YOCTO_DOCS_DEV_URL;#accessing-source-repositories>`__"
190 Section in the Yocto Project Development Tasks Manual. 190 Section in the Yocto Project Development Tasks Manual.
191 191
192- `Index of /releases: <&YOCTO_DL_URL;/releases/>`__ This is an index 192- :yocto_dl:`Index of /releases: <releases>` This is an index
193 of releases such as Poky, Pseudo, installers for cross-development 193 of releases such as Poky, Pseudo, installers for cross-development
194 toolchains, miscellaneous support and all released versions of Yocto 194 toolchains, miscellaneous support and all released versions of Yocto
195 Project in the form of images or tarballs. Downloading and extracting 195 Project in the form of images or tarballs. Downloading and extracting
@@ -204,14 +204,13 @@ development:
204 Releases <&YOCTO_DOCS_DEV_URL;#accessing-index-of-releases>`__" 204 Releases <&YOCTO_DOCS_DEV_URL;#accessing-index-of-releases>`__"
205 section in the Yocto Project Development Tasks Manual. 205 section in the Yocto Project Development Tasks Manual.
206 206
207- *"DOWNLOADS" page for the*\ `Yocto Project 207- *"DOWNLOADS" page for the* :yocto_home:`Yocto Project Website <>` *:*
208 Website <&YOCTO_HOME_URL;>`__\ *:*
209 208
210 The Yocto Project website includes a "DOWNLOADS" page accessible 209 The Yocto Project website includes a "DOWNLOADS" page accessible
211 through the "SOFTWARE" menu that allows you to download any Yocto 210 through the "SOFTWARE" menu that allows you to download any Yocto
212 Project release, tool, and Board Support Package (BSP) in tarball 211 Project release, tool, and Board Support Package (BSP) in tarball
213 form. The tarballs are similar to those found in the `Index of 212 form. The tarballs are similar to those found in the
214 /releases: <&YOCTO_DL_URL;/releases/>`__ area. 213 :yocto_dl:`Index of /releases: <releases>` area.
215 214
216 .. image:: figures/yp-download.png 215 .. image:: figures/yp-download.png
217 :align: center 216 :align: center
@@ -259,8 +258,8 @@ and so forth.
259 258
260The Yocto Project ``poky`` Git repository also has an upstream 259The Yocto Project ``poky`` Git repository also has an upstream
261contribution Git repository named ``poky-contrib``. You can see all the 260contribution Git repository named ``poky-contrib``. You can see all the
262branches in this repository using the web interface of the `Source 261branches in this repository using the web interface of the
263Repositories <&YOCTO_GIT_URL;>`__ organized within the "Poky Support" 262:yocto_git:`Source Repositories <>` organized within the "Poky Support"
264area. These branches hold changes (commits) to the project that have 263area. These branches hold changes (commits) to the project that have
265been submitted or committed by the Yocto Project development team and by 264been submitted or committed by the Yocto Project development team and by
266community members who contribute to the project. The maintainer 265community members who contribute to the project. The maintainer
@@ -400,7 +399,7 @@ Repositories, Tags, and Branches
400As mentioned briefly in the previous section and also in the "`Git 399As mentioned briefly in the previous section and also in the "`Git
401Workflows and the Yocto 400Workflows and the Yocto
402Project <#gs-git-workflows-and-the-yocto-project>`__" section, the Yocto 401Project <#gs-git-workflows-and-the-yocto-project>`__" section, the Yocto
403Project maintains source repositories at ` <&YOCTO_GIT_URL;>`__. If you 402Project maintains source repositories at :yocto_git:`/`. If you
404look at this web-interface of the repositories, each item is a separate 403look at this web-interface of the repositories, each item is a separate
405Git repository. 404Git repository.
406 405
@@ -432,7 +431,7 @@ files. Git uses "branches" to organize different development efforts.
432For example, the ``poky`` repository has several branches that include 431For example, the ``poky`` repository has several branches that include
433the current "DISTRO_NAME_NO_CAP" branch, the "master" branch, and many 432the current "DISTRO_NAME_NO_CAP" branch, the "master" branch, and many
434branches for past Yocto Project releases. You can see all the branches 433branches for past Yocto Project releases. You can see all the branches
435by going to ` <&YOCTO_GIT_URL;/cgit.cgi/poky/>`__ and clicking on the 434by going to https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the
436``[...]`` link beneath the "Branch" heading. 435``[...]`` link beneath the "Branch" heading.
437 436
438Each of these branches represents a specific area of development. The 437Each of these branches represents a specific area of development. The
@@ -472,7 +471,7 @@ Git uses "tags" to mark specific changes in a repository branch
472structure. Typically, a tag is used to mark a special point such as the 471structure. Typically, a tag is used to mark a special point such as the
473final change (or commit) before a project is released. You can see the 472final change (or commit) before a project is released. You can see the
474tags used with the ``poky`` Git repository by going to 473tags used with the ``poky`` Git repository by going to
475` <&YOCTO_GIT_URL;/cgit.cgi/poky/>`__ and clicking on the ``[...]`` link 474https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link
476beneath the "Tag" heading. 475beneath the "Tag" heading.
477 476
478Some key tags for the ``poky`` repository are ``jethro-14.0.3``, 477Some key tags for the ``poky`` repository are ``jethro-14.0.3``,
diff --git a/documentation/overview-manual/overview-manual-intro.rst b/documentation/overview-manual/overview-manual-intro.rst
index cddc176cff..2e96f1e338 100644
--- a/documentation/overview-manual/overview-manual-intro.rst
+++ b/documentation/overview-manual/overview-manual-intro.rst
@@ -66,8 +66,8 @@ Other Information
66 66
67Because this manual presents information for many different topics, 67Because this manual presents information for many different topics,
68supplemental information is recommended for full comprehension. For 68supplemental information is recommended for full comprehension. For
69additional introductory information on the Yocto Project, see the `Yocto 69additional introductory information on the Yocto Project, see the
70Project Website <&YOCTO_HOME_URL;>`__. If you want to build an image 70:yocto_home:`Yocto Project Website <>`. If you want to build an image
71with no knowledge of Yocto Project as a way of quickly testing it out, 71with no knowledge of Yocto Project as a way of quickly testing it out,
72see the `Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document. 72see the `Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document.
73For a comprehensive list of links and other documentation, see the 73For a comprehensive list of links and other documentation, see the
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst
index 3f98fa939c..743353547e 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -47,8 +47,8 @@ Project:
47 system, software, and service vendors exist whose products and 47 system, software, and service vendors exist whose products and
48 services adopt and support the Yocto Project. For a look at the Yocto 48 services adopt and support the Yocto Project. For a look at the Yocto
49 Project community and the companies involved with the Yocto Project, 49 Project community and the companies involved with the Yocto Project,
50 see the "COMMUNITY" and "ECOSYSTEM" tabs on the `Yocto 50 see the "COMMUNITY" and "ECOSYSTEM" tabs on the
51 Project <&YOCTO_HOME_URL;>`__ home page. 51 :yocto_home:`Yocto Project <>` home page.
52 52
53- *Architecture Agnostic:* Yocto Project supports Intel, ARM, MIPS, 53- *Architecture Agnostic:* Yocto Project supports Intel, ARM, MIPS,
54 AMD, PPC and other architectures. Most ODMs, OSVs, and chip vendors 54 AMD, PPC and other architectures. Most ODMs, OSVs, and chip vendors
@@ -482,8 +482,7 @@ The following list consists of components associated with the
482 OpenEmbedded-derived systems, which includes the Yocto Project. The 482 OpenEmbedded-derived systems, which includes the Yocto Project. The
483 Yocto Project and the OpenEmbedded Project both maintain the 483 Yocto Project and the OpenEmbedded Project both maintain the
484 OpenEmbedded-Core. You can find the OE-Core metadata in the Yocto 484 OpenEmbedded-Core. You can find the OE-Core metadata in the Yocto
485 Project `Source 485 Project :yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/meta>`.
486 Repositories <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta>`__.
487 486
488 Historically, the Yocto Project integrated the OE-Core metadata 487 Historically, the Yocto Project integrated the OE-Core metadata
489 throughout the Yocto Project source repository reference system 488 throughout the Yocto Project source repository reference system
@@ -543,8 +542,8 @@ targets:
543 applications that you can tailor to a specific, non-desktop platform 542 applications that you can tailor to a specific, non-desktop platform
544 to enhance usability in constrained environments. 543 to enhance usability in constrained environments.
545 544
546 You can find the Matchbox source in the Yocto Project `Source 545 You can find the Matchbox source in the Yocto Project
547 Repositories <&YOCTO_GIT_URL;>`__. 546 :yocto_git:`Source Repositories <>`.
548 547
549- *Opkg* Open PacKaGe management (opkg) is a lightweight package 548- *Opkg* Open PacKaGe management (opkg) is a lightweight package
550 management system based on the itsy package (ipkg) management system. 549 management system based on the itsy package (ipkg) management system.
@@ -696,8 +695,8 @@ into a usable binary image.
696Poky is a combined repository of BitBake, OpenEmbedded-Core (which is 695Poky is a combined repository of BitBake, OpenEmbedded-Core (which is
697found in ``meta``), ``meta-poky``, ``meta-yocto-bsp``, and documentation 696found in ``meta``), ``meta-poky``, ``meta-yocto-bsp``, and documentation
698provided all together and known to work well together. You can view 697provided all together and known to work well together. You can view
699these items that make up the Poky repository in the `Source 698these items that make up the Poky repository in the
700Repositories <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/>`__. 699:yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/>`.
701 700
702.. note:: 701.. note::
703 702
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 3e8127b927..dbd2aaf159 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -134,10 +134,9 @@ http://proxy.yoyodyne.com:18023/ # If you do not want to use proxy at
134all, set this to off. #use_proxy = on The Yocto Project also includes a 134all, set this to off. #use_proxy = on The Yocto Project also includes a
135``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS 135``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS
136and Git proxy servers if needed. For more information on setting up 136and Git proxy servers if needed. For more information on setting up
137various proxy types and configuring proxy servers, see the "`Working 137various proxy types and configuring proxy servers, see the
138Behind a Network 138":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`"
139Proxy <&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy>`__" Wiki 139Wiki page.
140page.
141 140
142**Q:** What’s the difference between target and target\ ``-native``? 141**Q:** What’s the difference between target and target\ ``-native``?
143 142
@@ -332,9 +331,9 @@ redirect requests through proxy servers.
332 331
333.. note:: 332.. note::
334 333
335 You can find more information on the " 334 You can find more information on the
336 Working Behind a Network Proxy 335 ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`"
337 " Wiki page. 336 Wiki page.
338 337
339**Q:** Can I get rid of build output so I can start over? 338**Q:** Can I get rid of build output so I can start over?
340 339
diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst
index 31959b2845..377932e2cf 100644
--- a/documentation/ref-manual/migration.rst
+++ b/documentation/ref-manual/migration.rst
@@ -1248,8 +1248,8 @@ The following reference BSPs changes occurred:
1248 1248
1249The previous reference BSPs for the ``beagleboard`` and 1249The previous reference BSPs for the ``beagleboard`` and
1250``routerstationpro`` machines are still available in a new 1250``routerstationpro`` machines are still available in a new
1251``meta-yocto-bsp-old`` layer in the `Source 1251``meta-yocto-bsp-old`` layer in the
1252Repositories <&YOCTO_GIT_URL;>`__ at 1252:yocto_git:`Source Repositories <>` at
1253http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/. 1253http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/.
1254 1254
1255Moving to the Yocto Project 1.7 Release 1255Moving to the Yocto Project 1.7 Release
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index 4b4f3bac5a..ae5f0e40d1 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -2749,7 +2749,7 @@ To use this class, you need to define a number of variables:
2749These variables list alternative commands needed by a package, provide 2749These variables list alternative commands needed by a package, provide
2750pathnames for links, default links for targets, and so forth. For 2750pathnames for links, default links for targets, and so forth. For
2751details on how to use this class, see the comments in the 2751details on how to use this class, see the comments in the
2752```update-alternatives.bbclass`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass>`__ 2752:yocto_git:`update-alternatives.bbclass </cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass>`
2753file. 2753file.
2754 2754
2755.. note:: 2755.. note::
diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst
index 4eba5cdf16..0e26e57155 100644
--- a/documentation/ref-manual/ref-images.rst
+++ b/documentation/ref-manual/ref-images.rst
@@ -40,8 +40,8 @@ Following is a list of supported recipes:
40 Player <http://www.vmware.com/products/player/overview.html>`__ or 40 Player <http://www.vmware.com/products/player/overview.html>`__ or
41 `VMware 41 `VMware
42 Workstation <http://www.vmware.com/products/workstation/overview.html>`__. 42 Workstation <http://www.vmware.com/products/workstation/overview.html>`__.
43 For more information on this image, see the `Build 43 For more information on this image, see the :yocto_home:`Build
44 Appliance <&YOCTO_HOME_URL;/software-item/build-appliance/>`__ page 44 Appliance <software-item/build-appliance>` page
45 on the Yocto Project website. 45 on the Yocto Project website.
46 46
47- ``core-image-base``: A console-only image that fully supports the 47- ``core-image-base``: A console-only image that fully supports the
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst
index 3144d303f8..a9a937b661 100644
--- a/documentation/ref-manual/ref-system-requirements.rst
+++ b/documentation/ref-manual/ref-system-requirements.rst
@@ -13,8 +13,8 @@ Rather, use this manual to find variable definitions, class
13descriptions, and so forth as needed during the course of using the 13descriptions, and so forth as needed during the course of using the
14Yocto Project. 14Yocto Project.
15 15
16For introductory information on the Yocto Project, see the `Yocto 16For introductory information on the Yocto Project, see the
17Project Website <&YOCTO_HOME_URL;>`__ and the "`Yocto Project 17:yocto_home:`Yocto Project Website <>` and the "`Yocto Project
18Development 18Development
19Environment <&YOCTO_DOCS_OM_URL;#overview-development-environment>`__" 19Environment <&YOCTO_DOCS_OM_URL;#overview-development-environment>`__"
20chapter in the Yocto Project Overview and Concepts Manual. 20chapter in the Yocto Project Overview and Concepts Manual.
@@ -68,8 +68,8 @@ distributions:
68 - If you encounter problems, please go to `Yocto Project 68 - If you encounter problems, please go to `Yocto Project
69 Bugzilla <&YOCTO_BUGZILLA_URL;>`__ and submit a bug. We are 69 Bugzilla <&YOCTO_BUGZILLA_URL;>`__ and submit a bug. We are
70 interested in hearing about your experience. For information on 70 interested in hearing about your experience. For information on
71 how to submit a bug, see the Yocto Project `Bugzilla wiki 71 how to submit a bug, see the Yocto Project
72 page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__ 72 :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`
73 and the "`Submitting a Defect Against the Yocto 73 and the "`Submitting a Defect Against the Yocto
74 Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__" 74 Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__"
75 section in the Yocto Project Development Tasks Manual. 75 section in the Yocto Project Development Tasks Manual.
@@ -255,7 +255,7 @@ installer and automatically installs the tools for you:
255 255
2561. Execute the ``install-buildtools`` script. Here is an example: $ cd 2561. Execute the ``install-buildtools`` script. Here is an example: $ cd
257 poky $ scripts/install-buildtools --without-extended-buildtools \\ 257 poky $ scripts/install-buildtools --without-extended-buildtools \\
258 --base-url YOCTO_DL_URL/releases/yocto \\ --release yocto-DISTRO \\ 258 --base-url https://downloads.yoctoproject.org/releases/yocto \\ --release yocto-DISTRO \\
259 --installer-version DISTRO 259 --installer-version DISTRO
260 260
261 During execution, the buildtools tarball will be downloaded, the 261 During execution, the buildtools tarball will be downloaded, the
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index 4bcd0a2d00..f56f7a993f 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -310,7 +310,7 @@ to locate and apply patch files to the source code.
310Patch files, by default, are ``*.patch`` and ``*.diff`` files created 310Patch files, by default, are ``*.patch`` and ``*.diff`` files created
311and kept in a subdirectory of the directory holding the recipe file. For 311and kept in a subdirectory of the directory holding the recipe file. For
312example, consider the 312example, consider the
313```bluez5`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/recipes-connectivity/bluez5>`__ 313:yocto_git:`bluez5 </cgit/cgit.cgi/poky/tree/meta/recipes-connectivity/bluez5>`
314recipe from the OE-Core layer (i.e. ``poky/meta``): 314recipe from the OE-Core layer (i.e. ``poky/meta``):
315poky/meta/recipes-connectivity/bluez5 This recipe has two patch files 315poky/meta/recipes-connectivity/bluez5 This recipe has two patch files
316located here: poky/meta/recipes-connectivity/bluez5/bluez5 316located here: poky/meta/recipes-connectivity/bluez5/bluez5
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst
index eacc49fc3d..ec9f6d3948 100644
--- a/documentation/ref-manual/ref-terms.rst
+++ b/documentation/ref-manual/ref-terms.rst
@@ -213,7 +213,7 @@ universal, the list includes them just in case:
213 213
214 In the context of the kernel ("kernel Metadata"), the term refers to 214 In the context of the kernel ("kernel Metadata"), the term refers to
215 the kernel config fragments and features contained in the 215 the kernel config fragments and features contained in the
216 ```yocto-kernel-cache`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache>`__ 216 :yocto_git:`yocto-kernel-cache </cgit/cgit.cgi/yocto-kernel-cache>`
217 Git repository. 217 Git repository.
218 218
219 OpenEmbedded-Core (OE-Core) 219 OpenEmbedded-Core (OE-Core)
@@ -227,8 +227,7 @@ universal, the list includes them just in case:
227 core set of recipes. 227 core set of recipes.
228 228
229 You can see the Metadata in the ``meta`` directory of the Yocto 229 You can see the Metadata in the ``meta`` directory of the Yocto
230 Project `Source 230 Project :yocto_git:`Source Repositories <>`.
231 Repositories <http://git.yoctoproject.org/cgit/cgit.cgi>`__.
232 231
233 OpenEmbedded Build System 232 OpenEmbedded Build System
234 The build system specific to the Yocto 233 The build system specific to the Yocto
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index aa7f59f602..53e99a395a 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -1853,9 +1853,9 @@ system and gives an overview of their function and contents.
1853 process gets source files when working behind a firewall or proxy 1853 process gets source files when working behind a firewall or proxy
1854 server, see this specific question in the 1854 server, see this specific question in the
1855 "`FAQ <#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server>`__" 1855 "`FAQ <#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server>`__"
1856 chapter. You can also refer to the "`Working Behind a Network 1856 chapter. You can also refer to the
1857 Proxy <&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy>`__" Wiki 1857 ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`"
1858 page. 1858 Wiki page.
1859 1859
1860 DOC_COMPRESS 1860 DOC_COMPRESS
1861 When inheriting the :ref:`compress_doc <ref-classes-compress_doc>` 1861 When inheriting the :ref:`compress_doc <ref-classes-compress_doc>`
@@ -3240,7 +3240,7 @@ system and gives an overview of their function and contents.
3240 recipe file. 3240 recipe file.
3241 3241
3242 See the 3242 See the
3243 ```local.conf.sample.extended`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>`__ 3243 :yocto_git:`local.conf.sample.extended </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>`
3244 file for additional information. Also, for information on creating an 3244 file for additional information. Also, for information on creating an
3245 initramfs, see the "`Building an Initial RAM Filesystem (initramfs) 3245 initramfs, see the "`Building an Initial RAM Filesystem (initramfs)
3246 Image <&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image>`__" section 3246 Image <&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image>`__" section
@@ -3740,8 +3740,8 @@ system and gives an overview of their function and contents.
3740 3740
3741 To specify the OE-Core versions for which a layer is compatible, use 3741 To specify the OE-Core versions for which a layer is compatible, use
3742 this variable in your layer's ``conf/layer.conf`` configuration file. 3742 this variable in your layer's ``conf/layer.conf`` configuration file.
3743 For the list, use the Yocto Project `Release 3743 For the list, use the Yocto Project
3744 Name <https://wiki.yoctoproject.org/wiki/Releases>`__ (e.g. 3744 :yocto_wiki:`Release Name </wiki/Releases>` (e.g.
3745 DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the 3745 DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the
3746 layer, use a space-separated list: LAYERSERIES_COMPAT_layer_root_name 3746 layer, use a space-separated list: LAYERSERIES_COMPAT_layer_root_name
3747 = "DISTRO_NAME_NO_CAP DISTRO_NAME_NO_CAP_MINUS_ONE" 3747 = "DISTRO_NAME_NO_CAP DISTRO_NAME_NO_CAP_MINUS_ONE"
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index 50f2afae03..b443cbfb79 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -33,7 +33,7 @@ Yocto Project Bugzilla
33====================== 33======================
34 34
35The Yocto Project uses its own implementation of 35The Yocto Project uses its own implementation of
36`Bugzilla <&YOCTO_BUGZILLA_URL;>`__ to track defects (bugs). 36:yocto_bugs:`Bugzilla <>` to track defects (bugs).
37Implementations of Bugzilla work well for group development because they 37Implementations of Bugzilla work well for group development because they
38track bugs and code changes, can be used to communicate changes and 38track bugs and code changes, can be used to communicate changes and
39problems with developers, can be used to submit and review patches, and 39problems with developers, can be used to submit and review patches, and
@@ -52,11 +52,9 @@ against the Yocto Project, see the following:
52 Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__" 52 Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__"
53 section in the Yocto Project Development Tasks Manual. 53 section in the Yocto Project Development Tasks Manual.
54 54
55- The Yocto Project `Bugzilla wiki 55- The Yocto Project :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`
56 page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__
57 56
58For information on Bugzilla in general, see 57For information on Bugzilla in general, see http://www.bugzilla.org/about/.
59` <http://www.bugzilla.org/about/>`__.
60 58
61.. _resources-mailinglist: 59.. _resources-mailinglist:
62 60
@@ -109,11 +107,10 @@ Links and Related Documentation
109 107
110Here is a list of resources you might find helpful: 108Here is a list of resources you might find helpful:
111 109
112- `The Yocto Project website <&YOCTO_HOME_URL;>`__\ *:* The home site 110- :yocto_home:`The Yocto Project Website <>`\ *:* The home site
113 for the Yocto Project. 111 for the Yocto Project.
114 112
115- `The Yocto Project Main Wiki 113- :yocto_wiki:`The Yocto Project Main Wiki Page </wiki/Main_Page>`\ *:* The main wiki page for
116 Page <&YOCTO_WIKI_URL;/wiki/Main_Page>`__\ *:* The main wiki page for
117 the Yocto Project. This page contains information about project 114 the Yocto Project. This page contains information about project
118 planning, release engineering, QA & automation, a reference site map, 115 planning, release engineering, QA & automation, a reference site map,
119 and other resources related to the Yocto Project. 116 and other resources related to the Yocto Project.
@@ -182,12 +179,12 @@ Here is a list of resources you might find helpful:
182 the :term:`OpenEmbedded Build System`, which uses 179 the :term:`OpenEmbedded Build System`, which uses
183 BitBake, that reports build information. 180 BitBake, that reports build information.
184 181
185- `FAQ <&YOCTO_WIKI_URL;/wiki/FAQ>`__\ *:* A list of commonly asked 182- :yocto_wiki:`FAQ </wiki/FAQ>`\ *:* A list of commonly asked
186 questions and their answers. 183 questions and their answers.
187 184
188- *Release Notes:* Features, updates and known issues for the current 185- *Release Notes:* Features, updates and known issues for the current
189 release of the Yocto Project. To access the Release Notes, go to the 186 release of the Yocto Project. To access the Release Notes, go to the
190 `Downloads <&YOCTO_HOME_URL;/software-overview/downloads/>`__ page on 187 :yocto_home:`Downloads </software-overview/downloads>` page on
191 the Yocto Project website and click on the "RELEASE INFORMATION" link 188 the Yocto Project website and click on the "RELEASE INFORMATION" link
192 for the appropriate release. 189 for the appropriate release.
193 190
@@ -195,8 +192,7 @@ Here is a list of resources you might find helpful:
195 the Yocto Project uses. If you find problems with the Yocto Project, 192 the Yocto Project uses. If you find problems with the Yocto Project,
196 you should report them using this application. 193 you should report them using this application.
197 194
198- `Bugzilla Configuration and Bug Tracking Wiki 195- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`\ *:*
199 Page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__\ *:*
200 Information on how to get set up and use the Yocto Project 196 Information on how to get set up and use the Yocto Project
201 implementation of Bugzilla for logging and tracking Yocto Project 197 implementation of Bugzilla for logging and tracking Yocto Project
202 defects. 198 defects.
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.rst b/documentation/sdk-manual/sdk-appendix-obtain.rst
index d6d534ea93..ed460c78ea 100644
--- a/documentation/sdk-manual/sdk-appendix-obtain.rst
+++ b/documentation/sdk-manual/sdk-appendix-obtain.rst
@@ -175,8 +175,8 @@ Follow these steps to extract the root filesystem:
1751. *Locate and Download the Tarball for the Pre-Built Root Filesystem 1751. *Locate and Download the Tarball for the Pre-Built Root Filesystem
176 Image File:* You need to find and download the root filesystem image 176 Image File:* You need to find and download the root filesystem image
177 file that is appropriate for your target system. These files are kept 177 file that is appropriate for your target system. These files are kept
178 in machine-specific folders in the `Index of 178 in machine-specific folders in the
179 Releases <&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;/machines/>`__ 179 :yocto_dl:`Index of Releases <releases/yocto/yocto-&DISTRO;/machines/>`
180 in the "machines" directory. 180 in the "machines" directory.
181 181
182 The machine-specific folders of the "machines" directory contain 182 The machine-specific folders of the "machines" directory contain
diff --git a/documentation/test-manual/test-manual-intro.rst b/documentation/test-manual/test-manual-intro.rst
index 3a40a0ad59..dc8de45fa8 100644
--- a/documentation/test-manual/test-manual-intro.rst
+++ b/documentation/test-manual/test-manual-intro.rst
@@ -150,7 +150,7 @@ thefollowing types of tests:
150 "`Testing Packages With 150 "`Testing Packages With
151 ptest <&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest>`__" section 151 ptest <&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest>`__" section
152 in the Yocto Project Development Tasks Manual and the 152 in the Yocto Project Development Tasks Manual and the
153 "`Ptest <&YOCTO_WIKI_URL;/wiki/Ptest>`__" Wiki page for more 153 ":yocto_wiki:`Ptest </wiki/Ptest>`" Wiki page for more
154 information on Ptest. 154 information on Ptest.
155 155
156- *SDK Testing:* Image tests initiated through the following command: $ 156- *SDK Testing:* Image tests initiated through the following command: $
diff --git a/documentation/toaster-manual/toaster-manual-reference.rst b/documentation/toaster-manual/toaster-manual-reference.rst
index d799b4b99b..0494f55d9e 100644
--- a/documentation/toaster-manual/toaster-manual-reference.rst
+++ b/documentation/toaster-manual/toaster-manual-reference.rst
@@ -160,14 +160,14 @@ As shipped, Toaster is configured to work with the following releases:
160- *Yocto Project DISTRO "DISTRO_NAME" or OpenEmbedded "DISTRO_NAME":* 160- *Yocto Project DISTRO "DISTRO_NAME" or OpenEmbedded "DISTRO_NAME":*
161 This release causes your Toaster projects to build against the head 161 This release causes your Toaster projects to build against the head
162 of the DISTRO_NAME_NO_CAP branch at 162 of the DISTRO_NAME_NO_CAP branch at
163 ` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/log/?h=rocko>`__ or 163 https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=rocko or
164 ` <http://git.openembedded.org/openembedded-core/commit/?h=rocko>`__. 164 http://git.openembedded.org/openembedded-core/commit/?h=rocko.
165 165
166- *Yocto Project "Master" or OpenEmbedded "Master":* This release 166- *Yocto Project "Master" or OpenEmbedded "Master":* This release
167 causes your Toaster Projects to build against the head of the master 167 causes your Toaster Projects to build against the head of the master
168 branch, which is where active development takes place, at 168 branch, which is where active development takes place, at
169 ` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/log/>`__ or 169 https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/ or
170 ` <http://git.openembedded.org/openembedded-core/log/>`__. 170 http://git.openembedded.org/openembedded-core/log/.
171 171
172- *Local Yocto Project or Local OpenEmbedded:* This release causes your 172- *Local Yocto Project or Local OpenEmbedded:* This release causes your
173 Toaster Projects to build against the head of the ``poky`` or 173 Toaster Projects to build against the head of the ``poky`` or