Task:Providing changes since last version of a package

m (→Background: Fix typo)
(→XML file: use <source>)
 
(7 intermediate revisions not shown)
Line 17: Line 17:
An example:
An example:
 +
<source lang="xml">
  <maemo-release-changelog>
  <maemo-release-changelog>
  <revision release-date="2008-07-07 23:05:00" revision="<package revision>">
  <revision release-date="2008-07-07 23:05:00" revision="<package revision>">
Line 29: Line 30:
  </release>
  </release>
  </maemo-release-changelog>
  </maemo-release-changelog>
 +
</source>
 +
When the XML file isn't found, fallback to ChangeLog and changelog. [Proposed by [[User:framstag|framstag]]]
-
When the XML file isn't found, fallback to ChangeLog and changelog. [Proposed by Tim Teulings]
+
I vote for this solution.
 +
Actually a small tool could be created to convert the XML to TXT (thus becoming a regular ChangeLog file)--[[User:anidel|anidel]] 15:33, 10 July 2008 (UTC)
=== Additional header in debian/control ===
=== Additional header in debian/control ===
Line 37: Line 41:
Certainly for downloads.maemo.org; for more detail the debian/changelog is available and /should/ be the definitive location so we don't diverge too much from other Debian-based systems. --[[User:jaffa]]
Certainly for downloads.maemo.org; for more detail the debian/changelog is available and /should/ be the definitive location so we don't diverge too much from other Debian-based systems. --[[User:jaffa]]
 +
 +
=== Comparison ===
 +
 +
(Commenting on my own proposal): I both suggestions as valid and good ideas. However they solve different problems. My proposal collects more data than acutally required to display the latest change (it has history) and is thus more complex, while the other solutions is far simpler and exactly fits the initial requirement. So the questions is: How much changelog do we need? For what purpose? If we do not find more purpose then initially requested I would suggest to start with the header aproach - just because it is simpler.--[[User:framstag|framstag]] 19:27, 14 July 2008 (UTC)
 +
 +
 +
[[Category:Community]]

Latest revision as of 14:19, 24 February 2011

Contents

[edit] Background

For the Application Manager and downloads.maemo.org it would be nice to have automatically updated information about changes since last version of a package. It would be good to have the change information available inside a package.

[edit] Problems

[edit] debian package changelog

The debian package changelog describes changed to the package made by the package maintainer. If maintainer and developer are different a changelog entry for a major relase could just contain "New upstream version".

[edit] ChangeLog

Another option would be to use the ChangeLog of the original source package - this would contain upstream documentation to changes in the original software. You would expect to find new features there. However upstream information might contain information of varying detail. Another problem is that the ChangeLog is "owned" by upstream, the maintainer can/should not change it.

[edit] Proposed solutions

[edit] XML file

Add a Maemo specific XML file for each package.

An example: 

 <maemo-release-changelog>
 <revision release-date="2008-07-07 23:05:00" revision="<package revision>">
   <description>
     Packages new upstream version.
   </description>
 </revision>
 <release release-date="2008-07-01 11:55:00" version="<source package version>">
   <description>
     Now plays funny sound on start.
   </description>
 </release>
 </maemo-release-changelog>

When the XML file isn't found, fallback to ChangeLog and changelog. [Proposed by framstag]

I vote for this solution. Actually a small tool could be created to convert the XML to TXT (thus becoming a regular ChangeLog file)--anidel 15:33, 10 July 2008 (UTC)

[edit] Additional header in debian/control

I wonder whether another header would be sufficient in debian/control? We've already got XB-Maemo-Icon, adding XBS-Version-Changes or something could be sufficient.

Certainly for downloads.maemo.org; for more detail the debian/changelog is available and /should/ be the definitive location so we don't diverge too much from other Debian-based systems. --User:jaffa

[edit] Comparison

(Commenting on my own proposal): I both suggestions as valid and good ideas. However they solve different problems. My proposal collects more data than acutally required to display the latest change (it has history) and is thus more complex, while the other solutions is far simpler and exactly fits the initial requirement. So the questions is: How much changelog do we need? For what purpose? If we do not find more purpose then initially requested I would suggest to start with the header aproach - just because it is simpler.--framstag 19:27, 14 July 2008 (UTC)

Retrieved from "http://wiki.maemo.org/Task:Providing_changes_since_last_version_of_a_package"