summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-11-23 09:30:12 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-12-13 23:31:34 +0000
commitb7693b7321bbc3f973d0f805a0da0b3469c10e7d (patch)
treebbd47d9290836b8e1ad82271c932813e3b7cca26 /documentation
parentd9e5f67c5f065496685a25cc25201700307dc6e8 (diff)
downloadpoky-b7693b7321bbc3f973d0f805a0da0b3469c10e7d.tar.gz
manuals: add hyperlinks to files in meta-skeleton
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. (From yocto-docs rev: 501917f65530f14ea686b69d6e96407c3f970a28) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/common-tasks.rst9
-rw-r--r--documentation/kernel-dev/advanced.rst11
-rw-r--r--documentation/kernel-dev/common.rst20
-rw-r--r--documentation/ref-manual/classes.rst5
4 files changed, 21 insertions, 24 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 9611a4f206..a4c13ee258 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -4725,11 +4725,14 @@ optimizations.
4725There are several examples in the ``meta-skeleton`` layer found in the 4725There are several examples in the ``meta-skeleton`` layer found in the
4726:term:`Source Directory`: 4726:term:`Source Directory`:
4727 4727
4728- ``conf/multilib-example.conf`` configuration file 4728- :oe_git:`conf/multilib-example.conf </openembedded-core/tree/meta-skeleton/conf/multilib-example.conf>`
4729 configuration file.
4729 4730
4730- ``conf/multilib-example2.conf`` configuration file 4731- :oe_git:`conf/multilib-example2.conf </openembedded-core/tree/meta-skeleton/conf/multilib-example2.conf>`
4732 configuration file.
4731 4733
4732- ``recipes-multilib/images/core-image-multilib-example.bb`` recipe 4734- :oe_git:`recipes-multilib/images/core-image-multilib-example.bb </openembedded-core/tree/meta-skeleton/recipes-multilib/images/core-image-multilib-example.bb>`
4735 recipe
4733 4736
4734Preparing to Use Multilib 4737Preparing to Use Multilib
4735~~~~~~~~~~~~~~~~~~~~~~~~~ 4738~~~~~~~~~~~~~~~~~~~~~~~~~
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
688--------------------- 688---------------------
689 689
690When stored in recipe-space, the kernel Metadata files reside in a 690When stored in recipe-space, the kernel Metadata files reside in a
691directory hierarchy below 691directory hierarchy below :term:`FILESEXTRAPATHS`. For
692:term:`FILESEXTRAPATHS`. For 692a linux-yocto recipe or for a Linux kernel recipe derived by copying
693a linux-yocto recipe or for a Linux kernel recipe derived by copying and 693:oe_git:`meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb
694modifying 694</openembedded-core/tree/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb>`
695``oe-core/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb`` to 695into your layer and modifying it, :term:`FILESEXTRAPATHS` is typically set to
696a recipe in your layer, :term:`FILESEXTRAPATHS` is typically set to
697``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``. 696``${``\ :term:`THISDIR`\ ``}/${``\ :term:`PN`\ ``}``.
698See the ":ref:`kernel-dev/common:modifying an existing recipe`" 697See the ":ref:`kernel-dev/common:modifying an existing recipe`"
699section for more information. 698section 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
1578on a future, mutually-supported kernel version. 1578on a future, mutually-supported kernel version.
1579 1579
1580To help you use your own sources, the Yocto Project provides a 1580To help you use your own sources, the Yocto Project provides a
1581linux-yocto custom recipe (``linux-yocto-custom.bb``) that uses 1581linux-yocto custom recipe that uses ``kernel.org`` sources and
1582``kernel.org`` sources and the Yocto Project Linux kernel tools for 1582the Yocto Project Linux kernel tools for managing kernel Metadata.
1583managing kernel Metadata. You can find this recipe in the ``poky`` Git 1583You can find this recipe in the ``poky`` Git repository:
1584repository of the Yocto Project :yocto_git:`Source Repository <>` 1584:yocto_git:`meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb
1585at:: 1585</poky/tree/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb>`.
1586
1587 poky/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb
1588 1586
1589Here are some basic steps you can use to work with your own sources: 1587Here are some basic steps you can use to work with your own sources:
1590 1588
@@ -1729,11 +1727,9 @@ Linux kernel sources, if you need an external kernel module, the
1729create your own out-of-tree Linux kernel module recipe. 1727create your own out-of-tree Linux kernel module recipe.
1730 1728
1731This template recipe is located in the ``poky`` Git repository of the 1729This template recipe is located in the ``poky`` Git repository of the
1732Yocto Project :yocto_git:`Source Repository <>` at: 1730Yocto Project:
1733 1731:yocto_git:`meta-skeleton/recipes-kernel/hello-mod/hello-mod_0.1.bb
1734.. code-block:: none 1732</poky/tree/meta-skeleton/recipes-kernel/hello-mod/hello-mod_0.1.bb>`.
1735
1736 poky/meta-skeleton/recipes-kernel/hello-mod/hello-mod_0.1.bb
1737 1733
1738To get started, copy this recipe to your layer and give it a meaningful 1734To get started, copy this recipe to your layer and give it a meaningful
1739name (e.g. ``mymodule_1.0.bb``). In the same directory, create a new 1735name (e.g. ``mymodule_1.0.bb``). 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
2810usage by the package on the target. For example, if you have packages 2810usage by the package on the target. For example, if you have packages
2811that contain system services that should be run under their own user or 2811that contain system services that should be run under their own user or
2812group, you can use these classes to enable creation of the user or 2812group, you can use these classes to enable creation of the user or
2813group. The ``meta-skeleton/recipes-skeleton/useradd/useradd-example.bb`` 2813group. The :oe_git:`meta-skeleton/recipes-skeleton/useradd/useradd-example.bb
2814</openembedded-core/tree/meta-skeleton/recipes-skeleton/useradd/useradd-example.bb>`
2814recipe in the :term:`Source Directory` provides a simple 2815recipe in the :term:`Source Directory` provides a simple
2815example that shows how to add three users and groups to two packages. 2816example that shows how to add three users and groups to two packages.
2816See the ``useradd-example.bb`` recipe for more information on how to use
2817these classes.
2818 2817
2819The ``useradd_base`` class provides basic functionality for user or 2818The ``useradd_base`` class provides basic functionality for user or
2820groups settings. 2819groups settings.