diff options
author | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-09-20 15:52:08 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-09-25 14:37:26 +0100 |
commit | 3eb4532cad8623400080a331d0e7cdcff033d309 (patch) | |
tree | aa859f57e1d2bc0074a88cb7fd3aa3c945c8ea98 /documentation/contributor-guide | |
parent | 5614e6b38a55df5df95556853961610c2b6bf329 (diff) | |
download | poky-3eb4532cad8623400080a331d0e7cdcff033d309.tar.gz |
contributor-guide/style-guide: Refer to recipes, not packages
Whilst often referred to as packages by people we should use the more
accurate term in documentation, 'recipe' instead of 'packages'.
(From yocto-docs rev: 058de5ad48ab76c4d54391f1701c3082842e8794)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/contributor-guide')
-rw-r--r-- | documentation/contributor-guide/recipe-style-guide.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst index 99105179a6..1a1c1c6ee2 100644 --- a/documentation/contributor-guide/recipe-style-guide.rst +++ b/documentation/contributor-guide/recipe-style-guide.rst | |||
@@ -7,17 +7,18 @@ Recipe Naming Conventions | |||
7 | ========================= | 7 | ========================= |
8 | 8 | ||
9 | In general, most recipes should follow the naming convention | 9 | In general, most recipes should follow the naming convention |
10 | ``recipes-category/package/packagename_version.bb``. Recipes for related | 10 | ``recipes-category/recipename/recipename_version.bb``. Recipes for related |
11 | projects may share the same package directory. ``packagename``, ``category``, | 11 | projects may share the same recipe directory. ``recipename`` and ``category`` |
12 | and ``package`` may contain hyphens, but hyphens are not allowed in ``version``. | 12 | may contain hyphens, but hyphens are not allowed in ``version``. |
13 | 13 | ||
14 | If the recipe is tracking a Git revision that does not correspond to a released | 14 | If the recipe is tracking a Git revision that does not correspond to a released |
15 | version of the software, ``version`` may be ``git`` (e.g. ``packagename_git.bb``) | 15 | version of the software, ``version`` may be ``git`` (e.g. ``recipename_git.bb``) |
16 | and the recipe would set :term:`PV`. | ||
16 | 17 | ||
17 | Version Policy | 18 | Version Policy |
18 | ============== | 19 | ============== |
19 | 20 | ||
20 | Our versions follow the form ``<package epoch>:<package version>-<package revision>`` | 21 | Our versions follow the form ``<epoch>:<version>-<revision>`` |
21 | or in BitBake variable terms ${:term:`PE`}:${:term:`PV`}-${:term:`PR`}. We | 22 | or in BitBake variable terms ${:term:`PE`}:${:term:`PV`}-${:term:`PR`}. We |
22 | generally follow the `Debian <https://www.debian.org/doc/debian-policy/ch-controlfields.html#version>`__ | 23 | generally follow the `Debian <https://www.debian.org/doc/debian-policy/ch-controlfields.html#version>`__ |
23 | version policy which defines these terms. | 24 | version policy which defines these terms. |
@@ -26,7 +27,7 @@ In most cases the version :term:`PV` will be set automatically from the recipe | |||
26 | file name. It is recommended to use released versions of software as these are | 27 | file name. It is recommended to use released versions of software as these are |
27 | revisions that upstream are expecting people to use. | 28 | revisions that upstream are expecting people to use. |
28 | 29 | ||
29 | Package versions should always compare and sort correctly so that upgrades work | 30 | Recipe versions should always compare and sort correctly so that upgrades work |
30 | as expected. With conventional versions such as ``1.4`` upgrading ``to 1.5`` | 31 | as expected. With conventional versions such as ``1.4`` upgrading ``to 1.5`` |
31 | this happens naturally, but some versions don't sort. For example, | 32 | this happens naturally, but some versions don't sort. For example, |
32 | ``1.5 Release Candidate 2`` could be written as ``1.5rc2`` but this sorts after | 33 | ``1.5 Release Candidate 2`` could be written as ``1.5rc2`` but this sorts after |
@@ -62,7 +63,7 @@ Version Number Changes | |||
62 | 63 | ||
63 | The :term:`PR` variable is used to indicate different revisions of a recipe | 64 | The :term:`PR` variable is used to indicate different revisions of a recipe |
64 | that reference the same upstream source version. It can be used to force a | 65 | that reference the same upstream source version. It can be used to force a |
65 | new version of a package to be installed onto a device from a package feed. | 66 | new version of a recipe to be installed onto a device from a package feed. |
66 | These once had to be set manually but in most cases these can now be set and | 67 | These once had to be set manually but in most cases these can now be set and |
67 | incremented automatically by a PR Server connected with a package feed. | 68 | incremented automatically by a PR Server connected with a package feed. |
68 | 69 | ||