Re: changelog: Do u read bottom-up or top-down?
Apologies first, this should have gone to d-mentors.
On Wednesday, 22. August 2001 12:57, Martin Albert wrote:
> You, who you do read changelogs: what do you use it for, do you read
> from top or bottom?
7 answers total, all 7 in 1 hour after the Q.
3 state they read changelogs (all versions) bottom-up.
Individual changelog entries (one version):
3 say they read them top-down.
1 reads them bottom-up.
2 admit reading and writing in random order.
1 says cvs lists latest entries first.
Noone said for what reason shes reading them anyway.
Thanks for all of your replies.
They lead to the following rough text that IMO doesn't fit to policy
and developers-reference is about sth. different too ...
The formal aspects of debian/changelog entries are described in the
policy manual; some hints can be found in the developers-reference.
Neither prescribes contents or ordering of individual entries.
You may, besides listing your changes in the order you made them,
consider to give an order to the individual entries that describe
changes to the upstream source, the debian directory and your build
scripts, files that you added yourself, the packages configuration and
changes to the packages layout and content.
Each individual entry should describe the files, changes that have been
made and possibly a reason for the change. Besides describing the
change history, the changelog is meant to give other developers and
users information why they should consider to install a particular
version of a package and issues to be aware of when testing a package.
This information is meant to be read from the changelog entry alone. It
should not be necessary to refer to other locations, eg. the BTS or
to have to diff against the previous version to see what has changed.
HTH, may the archive be with us, greetings, martin
Reply to: