diff mbox series

dev-manual: new-recipe.rst fix inconsistency with contributor guide

Message ID 20230912083536.414237-1-michael.opdenacker@bootlin.com
State New
Headers show
Series dev-manual: new-recipe.rst fix inconsistency with contributor guide | expand

Commit Message

Michael Opdenacker Sept. 12, 2023, 8:35 a.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

This document was suggesting a way to version pre-releases
which doesn't match the latest recommendations from the
contributor guide.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/dev-manual/new-recipe.rst | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)
diff mbox series

Patch

diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst
index cb9533ff5d..457f9632ce 100644
--- a/documentation/dev-manual/new-recipe.rst
+++ b/documentation/dev-manual/new-recipe.rst
@@ -1036,13 +1036,14 @@  build system and package managers, so the resulting packages will not
 correctly trigger an upgrade.
 
 In order to ensure the versions compare properly, the recommended
-convention is to set :term:`PV` within the
-recipe to "previous_version+current_version". You can use an additional
-variable so that you can use the current version elsewhere. Here is an
-example::
+convention is to use a tilde (``~``) character as follows::
 
-   REALPV = "0.8.16-rc1"
-   PV = "0.8.15+${REALPV}"
+  PV = 0.8.16~rc1
+
+This way ``0.8.16~rc1`` sorts before ``0.8.16``. See the
+":ref:`contributor-guide/recipe-style-guide:version policy`" section in the
+Yocto Project and OpenEmbedded Contributor Guide for more details about
+versioning code corresponding to a pre-release or to a specific Git commit.
 
 Post-Installation Scripts
 =========================