[v3,1/6] documentation: Simplify oe_wiki and oe_home links
Submitted by Paul Barker on Dec. 22, 2020, 3:30 p.m.
|
Patch ID: 179062
Details
Commit Message
@@ -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 <http://openembedded.org/wiki/Styleguide>`__".
+ recipes used in the Yocto Project found in the ":oe_wiki:`OpenEmbedded
+ Style Guide </Styleguide>`".
- *License File:* You must include a license file in the
``meta-bsp_root_name`` directory. This license covers the BSP
@@ -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
@@ -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/Styleguide>` wiki page
+guidelines. The :oe_wiki:`OpenEmbedded Styleguide </Styleguide>` wiki page
provides rough guidelines for preferred recipe style.
It is common for existing recipes to deviate a bit from this style.
@@ -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 <https://openembedded.org/wiki/Bitbake>`__ recipes and basic
+are comfortable working with :oe_wiki:`BitBake </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
@@ -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 <http://www.openembedded.org/wiki/Main_Page>`__ and
+ this capacity in the :oe_home:`OpenEmbedded <>` and
`OpenWrt <https://openwrt.org/>`__ projects, as well as the Yocto
Project.
@@ -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 </wiki/BitBake>`\ *:* The tool
- used to process metadata.
+- :oe_wiki:`BitBake </BitBake>`\ *:* The tool used to process metadata.
- :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive
guide to the BitBake tool. If you want information on BitBake, see