[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: RFS: dictconv (2nd try) [1]



On Tue, 09 Oct 2007 11:22:45 +0200
Francesco Namuri <francesco@namuri.it> wrote:

> > No need to put the full title of the ITP bug in debian/changelog
> 
> Fixed this one also, so it's useless to use dch --closes?

No, dch --closes is the recommended method for several reasons:
1. it looks up the bug title from the bug number so that you know you
have the right bug number. :-)
2. it ensures that you get the (Closes: #...) syntax correct
3. A long bug title is far better than no title at all - you can always
trim it.
4. the changelog should ALWAYS describe the entry being made.
  * Closes: #123456
	is completely unacceptable.
5. It ensures that when an upload closes many bugs, someone browsing
the changelog months after the upload knows WHICH bug to look up to
understand why a certain change was made.

So if you do not use "dch --closes" you need to use something very
similar and just as verbose.

Do not write changelog entries to suit yourself or to suit "now". Think
ahead and write changelog entries that are useful to someone who does
not know your package, someone looking at your changes many months /
releases down the line.

See the DD reference on best practice for changelog entries.

-- 


Neil Williams
=============
http://www.data-freedom.org/
http://www.nosoftwarepatents.com/
http://www.linux.codehelp.co.uk/

Attachment: pgpwDA0adFDuH.pgp
Description: PGP signature


Reply to: