From d903e586c219bca2f1967864a12a6164910a38e1 Mon Sep 17 00:00:00 2001 From: Paul Barker Date: Tue, 22 Dec 2020 15:30:27 +0000 Subject: documentation: Simplify oe_wiki and oe_home links (From yocto-docs rev: 6867f54f349edede37c4085194f51342c24297ed) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie --- documentation/bsp-guide/bsp.rst | 4 ++-- documentation/conf.py | 1 + documentation/dev-manual/common-tasks.rst | 2 +- documentation/kernel-dev/intro.rst | 3 +-- documentation/overview-manual/yp-intro.rst | 3 +-- documentation/ref-manual/resources.rst | 3 +-- 6 files changed, 7 insertions(+), 9 deletions(-) diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 068ab6c804..93e9182490 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst @@ -894,8 +894,8 @@ Yocto Project: ``recipes-*`` subdirectories specific to the recipe's function, or within a subdirectory containing a set of closely-related recipes. The recipes themselves should follow the general guidelines for - recipes used in the Yocto Project found in the "`OpenEmbedded Style - Guide `__". + recipes used in the Yocto Project found in the ":oe_wiki:`OpenEmbedded + Style Guide `". - *License File:* You must include a license file in the ``meta-bsp_root_name`` directory. This license covers the BSP diff --git a/documentation/conf.py b/documentation/conf.py index a626b1f14d..b5351599da 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -79,6 +79,7 @@ extlinks = { 'oe_home': ('https://www.openembedded.org%s', None), 'oe_lists': ('https://lists.openembedded.org%s', None), 'oe_git': ('https://git.openembedded.org%s', None), + 'oe_wiki': ('https://www.openembedded.org/wiki%s', None), } # Intersphinx config to use cross reference with Bitbake user manual diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index ada3bac7e1..39db6563c3 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -2540,7 +2540,7 @@ Following Recipe Style Guidelines --------------------------------- When writing recipes, it is good to conform to existing style -guidelines. The :oe_home:`OpenEmbedded Styleguide ` wiki page +guidelines. The :oe_wiki:`OpenEmbedded Styleguide ` wiki page provides rough guidelines for preferred recipe style. It is common for existing recipes to deviate a bit from this style. diff --git a/documentation/kernel-dev/intro.rst b/documentation/kernel-dev/intro.rst index c95d2f7cb9..f6c9b97137 100644 --- a/documentation/kernel-dev/intro.rst +++ b/documentation/kernel-dev/intro.rst @@ -72,8 +72,7 @@ tools with your own kernel sources. The remainder of this manual provides instructions for completing specific Linux kernel development tasks. These instructions assume you -are comfortable working with -`BitBake `__ recipes and basic +are comfortable working with :oe_wiki:`BitBake ` recipes and basic open-source development tools. Understanding these concepts will facilitate the process of working with the kernel recipes. If you find you need some additional background, please be sure to review and diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 66a88c9521..456bfc549a 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst @@ -531,8 +531,7 @@ targets: Debian Package (dpkg) in operation. Opkg is intended for use on embedded Linux devices and is used in - this capacity in the - `OpenEmbedded `__ and + this capacity in the :oe_home:`OpenEmbedded <>` and `OpenWrt `__ projects, as well as the Yocto Project. diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 77c3678095..2c49c4e87c 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -118,8 +118,7 @@ Here is a list of resources you might find helpful: distribution from which the Yocto Project derives its build system (Poky) and to which it contributes. -- :oe_home:`BitBake `\ *:* The tool - used to process metadata. +- :oe_wiki:`BitBake `\ *:* The tool used to process metadata. - :doc:`BitBake User Manual `\ *:* A comprehensive guide to the BitBake tool. If you want information on BitBake, see -- cgit v1.2.3-54-g00ecf