summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
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/ref-manual
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/ref-manual')
-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
9 files changed, 33 insertions, 39 deletions
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.