From 8faafa99cc9a45c1920ec3ea696a9ec7fb653194 Mon Sep 17 00:00:00 2001 From: Paul Barker Date: Fri, 27 Nov 2020 15:19:08 +0000 Subject: 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 Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/ref-manual/faq.rst | 4 ++-- documentation/ref-manual/migration-3.2.rst | 2 +- documentation/ref-manual/ref-release-process.rst | 4 ++-- documentation/ref-manual/ref-system-requirements.rst | 2 +- documentation/ref-manual/ref-variables.rst | 4 ++-- documentation/ref-manual/resources.rst | 9 +++++---- 6 files changed, 13 insertions(+), 12 deletions(-) (limited to 'documentation/ref-manual') 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 ``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS and Git proxy servers if needed. For more information on setting up various proxy types and configuring proxy servers, see the -":yocto_wiki:`Working Behind a Network Proxy `" +":yocto_wiki:`Working Behind a Network Proxy `" Wiki page. **Q:** What's the difference between target and target\ ``-native``? @@ -362,7 +362,7 @@ redirect requests through proxy servers. .. note:: You can find more information on the - ":yocto_wiki:`Working Behind a Network Proxy `" + ":yocto_wiki:`Working Behind a Network Proxy `" Wiki page. **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. In addition, pseudo's behaviour on mismatches has now been changed - rather than doing what turns out to be a rather dangerous "fixup" if it sees a file with a different path but the same inode as another file it has previously seen, -pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page ` +pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page ` that explains how to deal with this. 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. Releases are given a nominal release version as well but the codename is used in repositories for this reason. You can find information on Yocto Project releases and codenames at -:yocto_wiki:`/wiki/Releases`. +:yocto_wiki:`/Releases`. Stable Release Process ====================== @@ -94,7 +94,7 @@ Community LTS trees and branches exist where community members share patches for older releases. However, these types of patches do not go through the same release process as do point releases. You can find more information about stable branch maintenance at -:yocto_wiki:`/wiki/Stable_branch_maintenance`. +:yocto_wiki:`/Stable_branch_maintenance`. Testing and Quality Assurance ============================= 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: Bugzilla <>` and submit a bug. We are interested in hearing about your experience. For information on how to submit a bug, see the Yocto Project - :yocto_wiki:`Bugzilla wiki page ` + :yocto_wiki:`Bugzilla wiki page ` and the ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" section in the Yocto Project Development Tasks Manual. 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. process gets source files when working behind a firewall or proxy server, see this specific question in the ":doc:`faq`" chapter. You can also refer to the - ":yocto_wiki:`Working Behind a Network Proxy `" + ":yocto_wiki:`Working Behind a Network Proxy `" Wiki page. :term:`DOC_COMPRESS` @@ -4177,7 +4177,7 @@ system and gives an overview of their function and contents. To specify the OE-Core versions for which a layer is compatible, use this variable in your layer's ``conf/layer.conf`` configuration file. For the list, use the Yocto Project - :yocto_wiki:`Release Name ` (e.g. + :yocto_wiki:`Release Name ` (e.g. DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the layer, use a space-separated list: :: 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: - The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" section in the Yocto Project Development Tasks Manual. -- The Yocto Project :yocto_wiki:`Bugzilla wiki page ` +- The Yocto Project :yocto_wiki:`Bugzilla wiki page ` For information on Bugzilla in general, see http://www.bugzilla.org/about/. @@ -108,7 +108,7 @@ Here is a list of resources you might find helpful: - :yocto_home:`The Yocto Project Website <>`\ *:* The home site for the Yocto Project. -- :yocto_wiki:`The Yocto Project Main Wiki Page `\ *:* The main wiki page for +- :yocto_wiki:`The Yocto Project Main Wiki Page <>`\ *:* The main wiki page for the Yocto Project. This page contains information about project planning, release engineering, QA & automation, a reference site map, and other resources related to the Yocto Project. @@ -171,7 +171,7 @@ Here is a list of resources you might find helpful: the :term:`OpenEmbedded Build System`, which uses BitBake, that reports build information. -- :yocto_wiki:`FAQ `\ *:* A list of commonly asked +- :yocto_wiki:`FAQ `\ *:* A list of commonly asked questions and their answers. - *Release Notes:* Features, updates and known issues for the current @@ -184,7 +184,8 @@ Here is a list of resources you might find helpful: the Yocto Project uses. If you find problems with the Yocto Project, you should report them using this application. -- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page `\ *:* +- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page + `\ *:* Information on how to get set up and use the Yocto Project implementation of Bugzilla for logging and tracking Yocto Project defects. -- cgit v1.2.3-54-g00ecf