Upgrading packages: Difference between revisions

From Openembedded.org
Jump to navigation Jump to search
m (Fix versioning policy link)
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Do you know about the powers of [http://www.kernel.org/pub/software/scm/git/docs/git-mv.html <u>git-mv</u>]?  If you are upgrading a package you really should. 
= General upgrading procedures =


Please follow these steps when upgrading a package to a more recent version. This is not to be seen as dogma, but rather as best practice.  There are basically two cases we need to consider; a) you do want to keep the version of the bb file that is in OE now (somebody else needs this particular version) or b) you don't.
Different layers have different policies for keeping versions of software around. OE-Core for example is fairly agressive about having one, good, recent version of the software than many older versions. Other layers may have different policies.


= You do not need to keep the last version of the package =
There are two cases we need to consider:


# Use "[http://www.kernel.org/pub/software/scm/git/docs/git-mv.html <u>git-mv</u>] packages/$pkg/$file_v1.bb packages/$pkg/$file_v2.bb" so that we don't accumulate unecessary cruft.  Using the built-in rename function also ensures we can trace the changes for a package with "git log" even across upgrades.
# You do want to keep the version of the bb file that is in OE now (somebody else needs this particular version)
# make <u>further changes</u> to packages/$pkg/$file_v2.bb as appropriate.
# You don't.
# At the very minimum do a <u>compilation test</u> "bitbake $file" to make sure the new package does at least fetch and compile.
# inspect the output of "<u>git diff</u> packages/$pkg/".  Is this really what you want to commit?
# Final step, <u>publish your work</u>. "git commit packages/$pkg/ && git push"


= You do want to keep the last version of the package =
== If you do not need to keep the last version of the package ==


Same as above, except that between the first and second step you do
# Use <code>git mv recipes-xyz/recipename/recipename_1.0.bb recipes-xyz/recipename/recipename_2.0.bb</code>
# Make further changes to <code>recipes-xyz/recipename/recipename_2.0.bb</code> as appropriate.
# At the very minimum do a compilation test (<code>bitbake recipename</code>) to make sure the new package does at least fetch and compile.
# Consider using buildhistory to check for changes between the versions. See [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#maintaining-build-output-quality Maintaining Build Output Quality] in the Yocto Project Reference Manual.
# Inspect the output of "git diff recipes-xyz/recipename/".  Is this really what you want to commit?
# Final step - publish your work. See '''[[How to submit a patch to OpenEmbedded]]'''


cp packages/$pkg/$file_v2.bb packages/$pkg/$file_v1.bb
== If you do want to keep the last version of the package ==
git-add packages/$pkg/$file_v1.bb


Now, you may ask "Why rename the file first and then copy it back?"  Good question!  With using "git mv" to rename and then copying back we keep the "git log"-history forever.  Just "cp $a $b;git add $b" means we have a truncated history once $a gets removed.
Same as above, except instead of the first step:


= Removing recipes =
cp recipes-xyz/recipename/recipename_1.0.bb recipes-xyz/recipename/recipename_2.0.bb
git add recipes-xyz/recipename/recipename_2.0.bb


Although preventing the accumulation of cruft in the repository is good, you should take into account that distributions may be using a certain recipe and depend upon it. Therefore, before removing a recipe from the repository, do a grep in the 'conf/distro' directory. If the version you are going to remove is being explicitly used, send the respective patch to the development mailing list for 'RFC' first.
= Guidelines =


: I think this is too restrictive and I think above paragraph was added to this page without a directive from the core team who should have been the one to decide.  preferred-om-2008-versions.inc looks down virtually all recipes.  In essence, the above requirement for RFC translates into "all old version have to accumulate in HEAD or an RFC for their removal sent". I don't think that is what we want.  I will certainly not follow that like a slave for packages that I maintain (I will remove libassa-3.4.2 in a minute, for example, rather than wasting time on re-libtoolizing an obsolete fringe package.  Sorry). --[[User:Laibsch|Laibsch]] 22:07, 18 May 2009 (UTC)
* If it is present, remove any line setting PR on upgrades (when PV changes).
* Generally we try to avoid pre-release versions; however sometimes upstream doesn't give us a choice. See [[Versioning Policy]] for how to deal with pre-release versions.
* If LIC_FILES_CHKSUM needs to be changed as part of the upgrade, you '''must''' explain exactly why in the commit message. It's fine if it is just a copyright year, formatting or other minor change; however if the license text has changed in more substantially than that it may be that the license is now materially different.


[[Category:Policy]]
[[Category:Policy]]

Latest revision as of 13:24, 5 June 2014

General upgrading procedures

Different layers have different policies for keeping versions of software around. OE-Core for example is fairly agressive about having one, good, recent version of the software than many older versions. Other layers may have different policies.

There are two cases we need to consider:

  1. You do want to keep the version of the bb file that is in OE now (somebody else needs this particular version)
  2. You don't.

If you do not need to keep the last version of the package

  1. Use git mv recipes-xyz/recipename/recipename_1.0.bb recipes-xyz/recipename/recipename_2.0.bb
  2. Make further changes to recipes-xyz/recipename/recipename_2.0.bb as appropriate.
  3. At the very minimum do a compilation test (bitbake recipename) to make sure the new package does at least fetch and compile.
  4. Consider using buildhistory to check for changes between the versions. See Maintaining Build Output Quality in the Yocto Project Reference Manual.
  5. Inspect the output of "git diff recipes-xyz/recipename/". Is this really what you want to commit?
  6. Final step - publish your work. See How to submit a patch to OpenEmbedded

If you do want to keep the last version of the package

Same as above, except instead of the first step: 

cp recipes-xyz/recipename/recipename_1.0.bb recipes-xyz/recipename/recipename_2.0.bb
git add recipes-xyz/recipename/recipename_2.0.bb

Guidelines

  • If it is present, remove any line setting PR on upgrades (when PV changes).
  • Generally we try to avoid pre-release versions; however sometimes upstream doesn't give us a choice. See Versioning Policy for how to deal with pre-release versions.
  • If LIC_FILES_CHKSUM needs to be changed as part of the upgrade, you must explain exactly why in the commit message. It's fine if it is just a copyright year, formatting or other minor change; however if the license text has changed in more substantially than that it may be that the license is now materially different.
Retrieved from "https://www.openembedded.org/w/index.php?title=Upgrading_packages&oldid=7311"