MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 12:59:02 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

dev-manual: simplify recipe names to use "oe_git" links

Browse Source 
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 <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Robert P. J. Day 2025-06-25 05:23:56 -04:00 committed by Richard Purdie
parent c9f2036a56
commit 3be97486e3
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
documentation/dev-manual/new-recipe.rst
View File

@ -276,11 +276,11 @@ upgrading the recipe to a future version is as simple as renaming the
recipe to match the new version. recipe to match the new version.
Here is a simple example from the Here is a simple example from the
``meta/recipes-devtools/strace/strace_5.5.bb`` recipe where the source :oe_git:`strace recipe </openembedded-core/tree/meta/recipes-devtools/strace>`
comes from a single tarball. Notice the use of the where the source comes from a single tarball. Notice the use of the
:term:`PV` variable:: :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 Files mentioned in :term:`SRC_URI` whose names end in a typical archive
extension (e.g. ``.tar``, ``.tar.gz``, ``.tar.bz2``, ``.zip``, and so 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, 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 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 a ``+`` sign in its definition. Here is an example from the recipe
:oe_git:`meta/recipes-sato/l3afpad/l3afpad_git.bb </openembedded-core/tree/meta/recipes-sato/l3afpad/l3afpad_git.bb>`:: :oe_git:`l3afpad_git.bb </openembedded-core/tree/meta/recipes-sato/l3afpad/l3afpad_git.bb>`::
SRC_URI = "git://github.com/stevenhoneyman/l3afpad.git;branch=master;protocol=https" 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. continuing with the build.
This final example is a bit more complicated and is from the This final example is a bit more complicated and is from the
``meta/recipes-sato/rxvt-unicode/rxvt-unicode_9.20.bb`` recipe. The :oe_git:`rxvt-unicode </openembedded-core/tree/meta/recipes-sato/rxvt-unicode>`
example's :term:`SRC_URI` statement identifies multiple files as the source 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:: 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 \ SRC_URI = "http://dist.schmorp.de/rxvt-unicode/Attic/rxvt-unicode-${PV}.tar.bz2 \