diff options
| author | Robert P. J. Day <rpjday@crashcourse.ca> | 2025-06-25 05:23:56 -0400 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-06-30 17:44:22 +0100 |
| commit | 3be97486e3a3ad6ae5a91d4c5098571c87d42189 (patch) | |
| tree | 2a0020357366e5c3417dc749361f9563cf51b9d0 | |
| parent | c9f2036a56ce5675c39926cf4a16f918a461d05a (diff) | |
| download | poky-3be97486e3a3ad6ae5a91d4c5098571c87d42189.tar.gz | |
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 <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
| -rw-r--r-- | documentation/dev-manual/new-recipe.rst | 12 |
1 files 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 | |||
| 276 | recipe to match the new version. | 276 | recipe to match the new version. |
| 277 | 277 | ||
| 278 | Here is a simple example from the | 278 | Here is a simple example from the |
| 279 | ``meta/recipes-devtools/strace/strace_5.5.bb`` recipe where the source | 279 | :oe_git:`strace recipe </openembedded-core/tree/meta/recipes-devtools/strace>` |
| 280 | comes from a single tarball. Notice the use of the | 280 | where the source comes from a single tarball. Notice the use of the |
| 281 | :term:`PV` variable:: | 281 | :term:`PV` variable:: |
| 282 | 282 | ||
| 283 | SRC_URI = "https://strace.io/files/${PV}/strace-${PV}.tar.xz \ | 283 | SRC_URI = "${GITHUB_BASE_URI}/download/v${PV}/strace-${PV}.tar.xz \ |
| 284 | 284 | ||
| 285 | Files mentioned in :term:`SRC_URI` whose names end in a typical archive | 285 | Files mentioned in :term:`SRC_URI` whose names end in a typical archive |
| 286 | extension (e.g. ``.tar``, ``.tar.gz``, ``.tar.bz2``, ``.zip``, and so | 286 | 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 | |||
| 292 | Another way of specifying source is from an SCM. For Git repositories, | 292 | Another way of specifying source is from an SCM. For Git repositories, |
| 293 | you must specify :term:`SRCREV` and you should specify :term:`PV` to include | 293 | you must specify :term:`SRCREV` and you should specify :term:`PV` to include |
| 294 | a ``+`` sign in its definition. Here is an example from the recipe | 294 | a ``+`` sign in its definition. Here is an example from the recipe |
| 295 | :oe_git:`meta/recipes-sato/l3afpad/l3afpad_git.bb </openembedded-core/tree/meta/recipes-sato/l3afpad/l3afpad_git.bb>`:: | 295 | :oe_git:`l3afpad_git.bb </openembedded-core/tree/meta/recipes-sato/l3afpad/l3afpad_git.bb>`:: |
| 296 | 296 | ||
| 297 | SRC_URI = "git://github.com/stevenhoneyman/l3afpad.git;branch=master;protocol=https" | 297 | SRC_URI = "git://github.com/stevenhoneyman/l3afpad.git;branch=master;protocol=https" |
| 298 | 298 | ||
| @@ -347,8 +347,8 @@ paste them into your recipe and then run the build again to continue. | |||
| 347 | continuing with the build. | 347 | continuing with the build. |
| 348 | 348 | ||
| 349 | This final example is a bit more complicated and is from the | 349 | This final example is a bit more complicated and is from the |
| 350 | ``meta/recipes-sato/rxvt-unicode/rxvt-unicode_9.20.bb`` recipe. The | 350 | :oe_git:`rxvt-unicode </openembedded-core/tree/meta/recipes-sato/rxvt-unicode>` |
| 351 | example's :term:`SRC_URI` statement identifies multiple files as the source | 351 | recipe. The example's :term:`SRC_URI` statement identifies multiple files as the source |
| 352 | files for the recipe: a tarball, a patch file, a desktop file, and an icon:: | 352 | files for the recipe: a tarball, a patch file, a desktop file, and an icon:: |
| 353 | 353 | ||
| 354 | SRC_URI = "http://dist.schmorp.de/rxvt-unicode/Attic/rxvt-unicode-${PV}.tar.bz2 \ | 354 | SRC_URI = "http://dist.schmorp.de/rxvt-unicode/Attic/rxvt-unicode-${PV}.tar.bz2 \ |
