diff options
author | Paul Barker <pbarker@konsulko.com> | 2020-11-27 15:19:08 +0000 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-03 12:04:21 +0000 |
commit | 8faafa99cc9a45c1920ec3ea696a9ec7fb653194 (patch) | |
tree | 0b34a19a12e115e8b63219e5a6aec7a0b58b85bf /documentation/ref-manual | |
parent | 62c061968c12511dc09ad575caa75f8960ac27cf (diff) | |
download | poky-8faafa99cc9a45c1920ec3ea696a9ec7fb653194.tar.gz |
documentation: Simplify yocto_wiki links
The `yocto_wiki` external link directive is modified to include the
`/wiki` element of the URL so that we can simplify the links in the
text.
Note that there are still a couple of places where this directive
cannot be used, such as in the table of contents in index.rst.
(From yocto-docs rev: d8aa5f93d349f27db3d03a2c4bcc205649f45a8d)
Signed-off-by: Paul Barker <pbarker@konsulko.com>
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.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/migration-3.2.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-release-process.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/ref-system-requirements.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/resources.rst | 9 |
6 files changed, 13 insertions, 12 deletions
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 576863eec6..3ffc1f2c41 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
@@ -140,7 +140,7 @@ The Yocto Project also includes a | |||
140 | ``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS | 140 | ``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS |
141 | and Git proxy servers if needed. For more information on setting up | 141 | and Git proxy servers if needed. For more information on setting up |
142 | various proxy types and configuring proxy servers, see the | 142 | various proxy types and configuring proxy servers, see the |
143 | ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" | 143 | ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" |
144 | Wiki page. | 144 | Wiki page. |
145 | 145 | ||
146 | **Q:** What's the difference between target and target\ ``-native``? | 146 | **Q:** What's the difference between target and target\ ``-native``? |
@@ -362,7 +362,7 @@ redirect requests through proxy servers. | |||
362 | .. note:: | 362 | .. note:: |
363 | 363 | ||
364 | You can find more information on the | 364 | You can find more information on the |
365 | ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" | 365 | ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" |
366 | Wiki page. | 366 | Wiki page. |
367 | 367 | ||
368 | **Q:** Can I get rid of build output so I can start over? | 368 | **Q:** Can I get rid of build output so I can start over? |
diff --git a/documentation/ref-manual/migration-3.2.rst b/documentation/ref-manual/migration-3.2.rst index 9b65e26c48..65a9ff4cac 100644 --- a/documentation/ref-manual/migration-3.2.rst +++ b/documentation/ref-manual/migration-3.2.rst | |||
@@ -71,7 +71,7 @@ be monitoring. | |||
71 | In addition, pseudo's behaviour on mismatches has now been changed - rather | 71 | In addition, pseudo's behaviour on mismatches has now been changed - rather |
72 | than doing what turns out to be a rather dangerous "fixup" if it sees a file | 72 | than doing what turns out to be a rather dangerous "fixup" if it sees a file |
73 | with a different path but the same inode as another file it has previously seen, | 73 | with a different path but the same inode as another file it has previously seen, |
74 | pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </wiki/Pseudo_Abort>` | 74 | pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>` |
75 | that explains how to deal with this. | 75 | that explains how to deal with this. |
76 | 76 | ||
77 | 77 | ||
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst index a6d9ff60ec..c77a3bcb18 100644 --- a/documentation/ref-manual/ref-release-process.rst +++ b/documentation/ref-manual/ref-release-process.rst | |||
@@ -64,7 +64,7 @@ codename are likely to be compatible and thus work together. | |||
64 | Releases are given a nominal release version as well but the codename is | 64 | Releases are given a nominal release version as well but the codename is |
65 | used in repositories for this reason. You can find information on Yocto | 65 | used in repositories for this reason. You can find information on Yocto |
66 | Project releases and codenames at | 66 | Project releases and codenames at |
67 | :yocto_wiki:`/wiki/Releases`. | 67 | :yocto_wiki:`/Releases`. |
68 | 68 | ||
69 | Stable Release Process | 69 | Stable Release Process |
70 | ====================== | 70 | ====================== |
@@ -94,7 +94,7 @@ Community LTS trees and branches exist where community members share | |||
94 | patches for older releases. However, these types of patches do not go | 94 | patches for older releases. However, these types of patches do not go |
95 | through the same release process as do point releases. You can find more | 95 | through the same release process as do point releases. You can find more |
96 | information about stable branch maintenance at | 96 | information about stable branch maintenance at |
97 | :yocto_wiki:`/wiki/Stable_branch_maintenance`. | 97 | :yocto_wiki:`/Stable_branch_maintenance`. |
98 | 98 | ||
99 | Testing and Quality Assurance | 99 | Testing and Quality Assurance |
100 | ============================= | 100 | ============================= |
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst index fe7c9252ca..af8663a5b2 100644 --- a/documentation/ref-manual/ref-system-requirements.rst +++ b/documentation/ref-manual/ref-system-requirements.rst | |||
@@ -93,7 +93,7 @@ distributions: | |||
93 | Bugzilla <>` and submit a bug. We are | 93 | Bugzilla <>` and submit a bug. We are |
94 | interested in hearing about your experience. For information on | 94 | interested in hearing about your experience. For information on |
95 | how to submit a bug, see the Yocto Project | 95 | how to submit a bug, see the Yocto Project |
96 | :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` | 96 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
97 | and the ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" | 97 | and the ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" |
98 | section in the Yocto Project Development Tasks Manual. | 98 | section in the Yocto Project Development Tasks Manual. |
99 | 99 | ||
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index b24e1fa39e..921d19e7f5 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst | |||
@@ -1997,7 +1997,7 @@ system and gives an overview of their function and contents. | |||
1997 | process gets source files when working behind a firewall or proxy | 1997 | process gets source files when working behind a firewall or proxy |
1998 | server, see this specific question in the ":doc:`faq`" | 1998 | server, see this specific question in the ":doc:`faq`" |
1999 | chapter. You can also refer to the | 1999 | chapter. You can also refer to the |
2000 | ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" | 2000 | ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" |
2001 | Wiki page. | 2001 | Wiki page. |
2002 | 2002 | ||
2003 | :term:`DOC_COMPRESS` | 2003 | :term:`DOC_COMPRESS` |
@@ -4177,7 +4177,7 @@ system and gives an overview of their function and contents. | |||
4177 | To specify the OE-Core versions for which a layer is compatible, use | 4177 | To specify the OE-Core versions for which a layer is compatible, use |
4178 | this variable in your layer's ``conf/layer.conf`` configuration file. | 4178 | this variable in your layer's ``conf/layer.conf`` configuration file. |
4179 | For the list, use the Yocto Project | 4179 | For the list, use the Yocto Project |
4180 | :yocto_wiki:`Release Name </wiki/Releases>` (e.g. | 4180 | :yocto_wiki:`Release Name </Releases>` (e.g. |
4181 | DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the | 4181 | DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the |
4182 | layer, use a space-separated list: | 4182 | layer, use a space-separated list: |
4183 | :: | 4183 | :: |
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index c172aab259..70ba8e7be5 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
@@ -50,7 +50,7 @@ against the Yocto Project, see the following: | |||
50 | - The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" | 50 | - The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" |
51 | section in the Yocto Project Development Tasks Manual. | 51 | section in the Yocto Project Development Tasks Manual. |
52 | 52 | ||
53 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` | 53 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
54 | 54 | ||
55 | For information on Bugzilla in general, see http://www.bugzilla.org/about/. | 55 | For information on Bugzilla in general, see http://www.bugzilla.org/about/. |
56 | 56 | ||
@@ -108,7 +108,7 @@ Here is a list of resources you might find helpful: | |||
108 | - :yocto_home:`The Yocto Project Website <>`\ *:* The home site | 108 | - :yocto_home:`The Yocto Project Website <>`\ *:* The home site |
109 | for the Yocto Project. | 109 | for the Yocto Project. |
110 | 110 | ||
111 | - :yocto_wiki:`The Yocto Project Main Wiki Page </wiki/Main_Page>`\ *:* The main wiki page for | 111 | - :yocto_wiki:`The Yocto Project Main Wiki Page <>`\ *:* The main wiki page for |
112 | the Yocto Project. This page contains information about project | 112 | the Yocto Project. This page contains information about project |
113 | planning, release engineering, QA & automation, a reference site map, | 113 | planning, release engineering, QA & automation, a reference site map, |
114 | and other resources related to the Yocto Project. | 114 | and other resources related to the Yocto Project. |
@@ -171,7 +171,7 @@ Here is a list of resources you might find helpful: | |||
171 | the :term:`OpenEmbedded Build System`, which uses | 171 | the :term:`OpenEmbedded Build System`, which uses |
172 | BitBake, that reports build information. | 172 | BitBake, that reports build information. |
173 | 173 | ||
174 | - :yocto_wiki:`FAQ </wiki/FAQ>`\ *:* A list of commonly asked | 174 | - :yocto_wiki:`FAQ </FAQ>`\ *:* A list of commonly asked |
175 | questions and their answers. | 175 | questions and their answers. |
176 | 176 | ||
177 | - *Release Notes:* Features, updates and known issues for the current | 177 | - *Release Notes:* Features, updates and known issues for the current |
@@ -184,7 +184,8 @@ Here is a list of resources you might find helpful: | |||
184 | the Yocto Project uses. If you find problems with the Yocto Project, | 184 | the Yocto Project uses. If you find problems with the Yocto Project, |
185 | you should report them using this application. | 185 | you should report them using this application. |
186 | 186 | ||
187 | - :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`\ *:* | 187 | - :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page |
188 | </Bugzilla_Configuration_and_Bug_Tracking>`\ *:* | ||
188 | Information on how to get set up and use the Yocto Project | 189 | Information on how to get set up and use the Yocto Project |
189 | implementation of Bugzilla for logging and tracking Yocto Project | 190 | implementation of Bugzilla for logging and tracking Yocto Project |
190 | defects. | 191 | defects. |