From Fedora Project Wiki

Revision as of 23:37, 5 October 2010 by Toshio (talk | contribs) (make a draft for changelog entries)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Changelogs

Every time you make changes, that is, whenever you increment the E-V-R of a package, add a changelog entry. This is important not only to have an idea about the history of a package, but also to enable users, fellow packages, and QA people to easily spot the changes that you make.

If a particular change is related to a Bugzilla bug, include the bug ID in the changelog entry for easy reference, e.g.

* Wed Jun 14 2003 Joe Packager <joe at gmail.com> - 1.0-2
- Added README file (#42).

You must use one of the following formats:

* Fri Jun 23 2006 Jesse Keating <jkeating@redhat.com> - 0.6-4
- And fix the link syntax.
* Fri Jun 23 2006 Jesse Keating <jkeating@redhat.com> 0.6-4
- And fix the link syntax.
* Fri Jun 23 2006 Jesse Keating <jkeating@redhat.com>
- 0.6-4
- And fix the link syntax.

Changelog entries in package spec files should contain changes made to the packageing (ie, spec file) itself. This would including noting updating to a new version, adding a patch, fixing other spec sections, note bugs fixed, and CVE's if any. This would not otherwise include changes made upstream by the project thats packaged. Those changes would be appropriate for inclusion in update notes. See [Link to FESCo Policy] for more information on what to put in update notes.