manuals: add hyperlinks to files in meta-skeleton

Message ID
State New
Headers show
Series manuals: add hyperlinks to files in meta-skeleton | expand

Commit Message

Michael Opdenacker Nov. 23, 2021, 8:43 a.m. UTC
This makes the manuals easier to use.
Note the care to keep the paths visible, so that people
reading a printed version still know where to find the files.

Signed-off-by: Michael Opdenacker <>
 documentation/dev-manual/common-tasks.rst |  9 ++++++---
 documentation/kernel-dev/advanced.rst     | 11 +++++------
 documentation/kernel-dev/common.rst       | 20 ++++++++------------
 documentation/ref-manual/classes.rst      |  5 ++---
 4 files changed, 21 insertions(+), 24 deletions(-)


diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 3eead147a3..6454133867 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -4730,11 +4730,14 @@  optimizations.
 There are several examples in the ``meta-skeleton`` layer found in the
 :term:`Source Directory`:
--  ``conf/multilib-example.conf`` configuration file
+-  :oe_git:`conf/multilib-example.conf </openembedded-core/tree/meta-skeleton/conf/multilib-example.conf>`
+   configuration file.
--  ``conf/multilib-example2.conf`` configuration file
+-  :oe_git:`conf/multilib-example2.conf </openembedded-core/tree/meta-skeleton/conf/multilib-example2.conf>`
+   configuration file.
--  ``recipes-multilib/images/`` recipe
+-  :oe_git:`recipes-multilib/images/ </openembedded-core/tree/meta-skeleton/recipes-multilib/images/>`
+   recipe
 Preparing to Use Multilib
diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst
index 2dbcca60c1..5a6b466ffb 100644
--- a/documentation/kernel-dev/advanced.rst
+++ b/documentation/kernel-dev/advanced.rst
@@ -688,12 +688,11 @@  Recipe-Space Metadata
 When stored in recipe-space, the kernel Metadata files reside in a
-directory hierarchy below
-a linux-yocto recipe or for a Linux kernel recipe derived by copying and
-``oe-core/meta-skeleton/recipes-kernel/linux/`` to
-a recipe in your layer, :term:`FILESEXTRAPATHS` is typically set to
+directory hierarchy below :term:`FILESEXTRAPATHS`. For
+a linux-yocto recipe or for a Linux kernel recipe derived by copying
+into your layer and modifying it, :term:`FILESEXTRAPATHS` is typically set to
 ``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``.
 See the ":ref:`kernel-dev/common:modifying an existing recipe`"
 section for more information.
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index d42ca5f99a..a5dd02ccf2 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -1578,13 +1578,11 @@  Maintaining format compatibility facilitates converging with linux-yocto
 on a future, mutually-supported kernel version.
 To help you use your own sources, the Yocto Project provides a
-linux-yocto custom recipe (````) that uses
-```` sources and the Yocto Project Linux kernel tools for
-managing kernel Metadata. You can find this recipe in the ``poky`` Git
-repository of the Yocto Project :yocto_git:`Source Repository <>`
-   poky/meta-skeleton/recipes-kernel/linux/
+linux-yocto custom recipe that uses ```` sources and
+the Yocto Project Linux kernel tools for managing kernel Metadata.
+You can find this recipe in the ``poky`` Git repository:
 Here are some basic steps you can use to work with your own sources:
@@ -1729,11 +1727,9 @@  Linux kernel sources, if you need an external kernel module, the
 create your own out-of-tree Linux kernel module recipe.
 This template recipe is located in the ``poky`` Git repository of the
-Yocto Project :yocto_git:`Source Repository <>` at:
-.. code-block:: none
-   poky/meta-skeleton/recipes-kernel/hello-mod/
+Yocto Project:
 To get started, copy this recipe to your layer and give it a meaningful
 name (e.g. ````). In the same directory, create a new
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 5bc4472e34..a33a5909ca 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2810,11 +2810,10 @@  The ``useradd*`` classes support the addition of users or groups for
 usage by the package on the target. For example, if you have packages
 that contain system services that should be run under their own user or
 group, you can use these classes to enable creation of the user or
-group. The ``meta-skeleton/recipes-skeleton/useradd/``
+group. The :oe_git:`meta-skeleton/recipes-skeleton/useradd/
 recipe in the :term:`Source Directory` provides a simple
 example that shows how to add three users and groups to two packages.
-See the ```` recipe for more information on how to use
-these classes.
 The ``useradd_base`` class provides basic functionality for user or
 groups settings.