Changelog bug format

[Martin Pitt]

Hi Daniel,

Daniel Silverstone [2006-03-15 10:05 +0000]:
> Option One: Re-use the malone email command interface to close bugs.
> Pros: Information/knowledge share, potential code share
> Cons: The malone email interface isn't ideal for changelogs. Could
> result in a too specific context in the changelog.
> Example:
> foo (1.0) dapper; urgency=low
> 
>  * Did some stuff
>    bug 2001
>    affects /distros/ubuntu/dapper status fix-released

This seems way too overengineered and error prone. (Ab)using
changelogs for bug triage should not be encouraged. Usually you want
to close a task for the distro you're uploading to, not more.

> Option Two: Simple modification of the Debian closes syntax
> Pros: Less change from an established format for changelogs already
> Cons: May be too easy to make a mistake and close a bug in the wrong
> tracker
> Example:
> foo (1.0) dapper; urgency=low
> 
>  * Did some stuff
>  * closes: lpbug #2001

This is my favourite option so far. Maybe 'lpbug' could be a little
nicer, like 'Launchpad', but I don't particularly mind that.

> Option Three: Instructions for launchpad
> Pros: Unlikely to be confused for another format, offers opportunity for
> extension later to things like marking specs as implemented.
> Cons: Slightly more verbiage than option two, not as neat and tidy.
> Introduces yet another language for talking about bugs etc.
> Example:
> foo (1.0) dapper; urgency=low
> 
>  * Did some stuff
>  * launchpad: close bug 2001

Too verbose for my taste, and smells like overengineering, too, IMHO.

> Obviously we're open to other ideas. Please follow up to this mail with
> a full option as I have above so that we have everything neatly there to
> make a decision.

My own favourite would be to keep it as short as possible to neatly
fit at the end of lines:

 foo (1.0) dapper; urgency=low
 
  * Fix typo (Launchpad: #123)
  * debian/postinst: Fix two other stupids bugs (Launchpad: #345, #456)

(s/Launchpad/lpbug/ would be fine for me, too)

Martin
-- 
Martin Pitt        http://www.piware.de
Ubuntu Developer   http://www.ubuntu.com
Debian Developer   http://www.debian.org

In a world without walls and fences, who needs Windows and Gates?
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 191 bytes
Desc: Digital signature
Url : https://lists.ubuntu.com/archives/ubuntu-devel/attachments/20060315/62d1ead4/attachment.pgp