Bug 6243 - Recipe versioning for non-final releases incorrectly documented
Summary: Recipe versioning for non-final releases incorrectly documented
Status: RESOLVED FIXED
Alias: None
Product: Development Manual
Classification: Documentation
Component: development (show other bugs)
Version: 1.6
Hardware: All Multiple
: Undecided normal
Target Milestone: ---
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 29 April 2014: RESOLVED/FIXED
Depends on:
Blocks:
 
Reported: 2014-04-28 15:15 UTC by Paul Eggleton
Modified: 2014-04-29 18:52 UTC (History)
1 user (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Paul Eggleton 2014-04-28 15:15:45 UTC
It seems when we were writing the new "Writing a New Recipe" section we picked up a bad example from the metadata - xdg-utils_1.1.0-rc1.bb. The way this has been versioned will lead to problems when the recipe is eventually upgraded to the final 1.1.0 release, because a change from "1.1.0rc1" to "1.1.0" would be seen as a decrease rather than an increase. We should be using "1.0.2+1.1.0rc1" for the version; usually this is done by setting PV in the recipe (and adjusting SRC_URI to match). Unfortunately our xdg-utils recipe doesn't do this and we don't have an example in OE-Core; here is one from meta-oe:

  http://git.openembedded.org/meta-openembedded/tree/meta-oe/recipes-connectivity/irssi/irssi_0.8.16-rc1.bb

This is touched on in the following OE wiki page:

  http://www.openembedded.org/wiki/Versioning_Policy

I suspect we need to add a note or a subsection that talks about correctly handling pre-release versions.
Comment 1 Scott Rifenbark 2014-04-29 18:52:53 UTC
I have added a new section called "Properly Versioning Pre-Release Recipes" to address making sure that recipes that are in a release candidate stage (e.g. name.0.1.0.rc1) are properly versioned by the build system.  The section has been reviewed and approved by Paul. See http://www.yoctoproject.org/docs/1.7/dev-manual/dev-manual.html#properly-versioning-pre-release-recipes.

The commit was pushed to the master and daisy branches.

Scott