Update notes referring to files within the package

Kevin Kofler kevin.kofler at chello.at
Mon Sep 16 20:45:27 UTC 2013


lately, I have seen an increasing number of update notes like this:
> See [some file in the package] for more information.

While done with noble intentions, unfortunately, this is not of much use, 
because update notes are read BEFORE updating the package, whereas the file 
being referred to is only available (in the correct version) AFTER 
installing or updating the package.

So please, instead of writing this, either:
(a) link to a copy of the file in cgit/gitweb/ViewVC/Trac/…, if available or
(b) link to a web page with the news instead, if available or
(c) paste the contents of the file into the update notes.

(Of course, the all-too-frequent "New upstream release." with no further 
information is also a VERY unhelpful kind of update notes, so it is not a 
reasonable alternative.)

Thank you for your understanding,
        Kevin Kofler

More information about the devel mailing list