From 3be97486e3a3ad6ae5a91d4c5098571c87d42189 Mon Sep 17 00:00:00 2001 From: "Robert P. J. Day" Date: Wed, 25 Jun 2025 05:23:56 -0400 Subject: [PATCH] dev-manual: simplify recipe names to use "oe_git" links Shorten a small number of cumbersome recipe names by replacing them with :oe_git: markup to link to their repositories. (From yocto-docs rev: bdcc97d4d605c3de9682b9cb055c253547397f13) Signed-off-by: Robert P. J. Day Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/dev-manual/new-recipe.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst index c8cf6b458e..6ee94fd6e5 100644 --- a/documentation/dev-manual/new-recipe.rst +++ b/documentation/dev-manual/new-recipe.rst @@ -276,11 +276,11 @@ upgrading the recipe to a future version is as simple as renaming the recipe to match the new version. Here is a simple example from the -``meta/recipes-devtools/strace/strace_5.5.bb`` recipe where the source -comes from a single tarball. Notice the use of the +:oe_git:`strace recipe ` +where the source comes from a single tarball. Notice the use of the :term:`PV` variable:: - SRC_URI = "https://strace.io/files/${PV}/strace-${PV}.tar.xz \ + SRC_URI = "${GITHUB_BASE_URI}/download/v${PV}/strace-${PV}.tar.xz \ Files mentioned in :term:`SRC_URI` whose names end in a typical archive extension (e.g. ``.tar``, ``.tar.gz``, ``.tar.bz2``, ``.zip``, and so @@ -292,7 +292,7 @@ another example that specifies these types of files, see the Another way of specifying source is from an SCM. For Git repositories, you must specify :term:`SRCREV` and you should specify :term:`PV` to include a ``+`` sign in its definition. Here is an example from the recipe -:oe_git:`meta/recipes-sato/l3afpad/l3afpad_git.bb `:: +:oe_git:`l3afpad_git.bb `:: SRC_URI = "git://github.com/stevenhoneyman/l3afpad.git;branch=master;protocol=https" @@ -347,8 +347,8 @@ paste them into your recipe and then run the build again to continue. continuing with the build. This final example is a bit more complicated and is from the -``meta/recipes-sato/rxvt-unicode/rxvt-unicode_9.20.bb`` recipe. The -example's :term:`SRC_URI` statement identifies multiple files as the source +:oe_git:`rxvt-unicode ` +recipe. The example's :term:`SRC_URI` statement identifies multiple files as the source files for the recipe: a tarball, a patch file, a desktop file, and an icon:: SRC_URI = "http://dist.schmorp.de/rxvt-unicode/Attic/rxvt-unicode-${PV}.tar.bz2 \