diff options
author | Antonin Godard <antonin.godard@bootlin.com> | 2024-12-09 17:43:43 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2024-12-20 12:47:59 +0000 |
commit | c9565b89d070d31db5f4e4ee499f4905938ed4f6 (patch) | |
tree | 38ea29bf46a83ac8df36ef5fe165342fe962604a /documentation/contributor-guide | |
parent | 6968e17ae5992fd7948098e5d5221a3e106e3452 (diff) | |
download | poky-c9565b89d070d31db5f4e4ee499f4905938ed4f6.tar.gz |
Update the documentation for SRCPV
The variable SRCPV is deprecated since 4.3. Instead of including SRCPV
in PV, including the sign "+" is enough for bitbake to add the source
control information to PKGV during the packaging phase.
Update the documentation for SRCPV and the places where it was used.
When instructions previously referred to SRCPV, replace by mentioning to
include "+" in the assignment.
In most examples, "+git" is added to PV as it is the most popular SCM.
Simply adding "+" is also possible, although it is better practice to
include the SCM name, so give that example.
Update the gcompat example with l3afpad as it didn't include "+git" in
its PV definition anymore.
(From yocto-docs rev: ee16c96202e5027d1a8d7e89e11c25f127c78326)
Signed-off-by: Antonin Godard <antonin.godard@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 | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst index 6a3eec3a0e..806bf23848 100644 --- a/documentation/contributor-guide/recipe-style-guide.rst +++ b/documentation/contributor-guide/recipe-style-guide.rst | |||
@@ -47,10 +47,10 @@ Debian policy closely. | |||
47 | 47 | ||
48 | When a recipe references a git revision that does not correspond to a released | 48 | When a recipe references a git revision that does not correspond to a released |
49 | version of software (e.g. is not a tagged version), the :term:`PV` variable | 49 | version of software (e.g. is not a tagged version), the :term:`PV` variable |
50 | should include the Git revision using the following to make the | 50 | should include the sign ``+``, so :term:`bitbake` automatically includes package |
51 | version clear:: | 51 | version information during the packaging phase:: |
52 | 52 | ||
53 | PV = "<version>+git${SRCPV}" | 53 | PV = "<version>+git" |
54 | 54 | ||
55 | In this case, ``<version>`` should be the most recently released version of the | 55 | In this case, ``<version>`` should be the most recently released version of the |
56 | software from the current source revision (``git describe`` can be useful for | 56 | software from the current source revision (``git describe`` can be useful for |