FAQ Search Today's Posts Mark Forums Read
» Video Reviews

» Linux Archive

Linux-archive is a website aiming to archive linux email lists and to make them easily accessible for linux users/developers.


» Sponsor

» Partners

» Sponsor

Go Back   Linux Archive > Debian > Debian Development

 
 
LinkBack Thread Tools
 
Old 07-13-2012, 03:58 PM
Jonas Smedegaard
 
Default Package changelog should contain, well, a log of changes

Hi fellow Debian folks,

Please, when composing debian/changelog for package releases, take a
moment to reflect on what you put into that file and how you phrase it.

It is a changelog, so should contain a list of changes.

This is not a list of changes:

python3-defaults (3.2.3-4) unstable; urgency=high

* py3clean: really close #681389

Yes, we have nifty mechanisms in place to close bugs based on magic
phrasing of changelog entries, but that's a bonus, not the main purpose
of that file.

Yes, it is possible to look up that bugreport online to learn more, or
sometimes (like this one) learn more from reading further back in the
logfile. But that's bad style.

Please write (brief but) explicitly what was changed in the packaging,
and please make each changelog section self-contained.

Something like this would be much better (yes it repeats some phrasing
from earlier changelog section to be self-contained):

python3-defaults (3.2.3-4) unstable; urgency=high

* py3clean: accept --package *and* directory name at the same time
(really this time). Closes: #681389.


Some use nifty tools to reuse titles from bugreports in changelog
entries. But often those titles describe what is the bug, not what will
be the change.

Please proofread your changelog before releasing a packaging, and make
sure all entries describe what was _changed_.

(no examples of ill-doing like that in today's changelog - great!)


Regards,

- Jonas

--
* Jonas Smedegaard - idealist & Internet-arkitekt
* Tlf.: +45 40843136 Website: http://dr.jones.dk/

[x] quote me freely [ ] ask before reusing [ ] keep private
 
Old 07-13-2012, 06:39 PM
Cyril Brulebois
 
Default Package changelog should contain, well, a log of changes

Jonas Smedegaard <dr@jones.dk> (13/07/2012):
> Please proofread your changelog before releasing a packaging, and make
> sure all entries describe what was _changed_. ^^^^^^^^^

SNCR,
KiBi.
 
Old 07-13-2012, 10:24 PM
Jonas Smedegaard
 
Default Package changelog should contain, well, a log of changes

On 12-07-13 at 08:39pm, Cyril Brulebois wrote:
> Jonas Smedegaard <dr@jones.dk> (13/07/2012):
> > Please proofread your changelog before releasing a packaging, and make
> > sure all entries describe what was _changed_. ^^^^^^^^^
>
> SNCR,
> KiBi.

I fail to extract any meaning out of the above.

Could you please elaborate?


- Jonas

--
* Jonas Smedegaard - idealist & Internet-arkitekt
* Tlf.: +45 40843136 Website: http://dr.jones.dk/

[x] quote me freely [ ] ask before reusing [ ] keep private
 
Old 07-13-2012, 10:46 PM
Craig Small
 
Default Package changelog should contain, well, a log of changes

On Sat, Jul 14, 2012 at 12:24:44AM +0200, Jonas Smedegaard wrote:
> On 12-07-13 at 08:39pm, Cyril Brulebois wrote:
> > Jonas Smedegaard <dr@jones.dk> (13/07/2012):
> > > Please proofread your changelog before releasing a packaging, and make
> > > sure all entries describe what was _changed_. ^^^^^^^^^
> >
> > SNCR,
> > KiBi.
>
> I fail to extract any meaning out of the above.
> Could you please elaborate?
It should of been package not packaging. I got that bit.
Still, I'm not sure what "Stevie Nicks Concert Reviews" or the "Society
for New Communications Research" has got to do with it.

- Craig
--
Craig Small VK2XLZ http://enc.com.au/ csmall at : enc.com.au
Debian GNU/Linux http://www.debian.org/ csmall at : debian.org
GPG fingerprint: 5D2F B320 B825 D939 04D2 0519 3938 F96B DF50 FEA5


--
To UNSUBSCRIBE, email to debian-devel-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Archive: 20120713224622.GA25188@enc.com.au">http://lists.debian.org/20120713224622.GA25188@enc.com.au
 
Old 07-14-2012, 07:14 AM
Sune Vuorela
 
Default Package changelog should contain, well, a log of changes

On 2012-07-13, Craig Small <csmall@debian.org> wrote:
>> On 12-07-13 at 08:39pm, Cyril Brulebois wrote:
>> > SNCR,
>> > KiBi.

> It should of been package not packaging. I got that bit.
> Still, I'm not sure what "Stevie Nicks Concert Reviews" or the "Society
> for New Communications Research" has got to do with it.

I guess it is short for "Sorry Not Could Resist".

It is most likely due to the following law:

Everytime you correct spelling errors on the internet,
you have a spelling error in your message correcting it

Sorry, Could Not Resist.

/Sune


--
To UNSUBSCRIBE, email to debian-devel-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Archive: slrnk0273g.mo3.nospam@sshway.ssh.pusling.com">http ://lists.debian.org/slrnk0273g.mo3.nospam@sshway.ssh.pusling.com
 
Old 07-14-2012, 07:46 AM
Chris Bannister
 
Default Package changelog should contain, well, a log of changes

On Sat, Jul 14, 2012 at 08:46:22AM +1000, Craig Small wrote:
> On Sat, Jul 14, 2012 at 12:24:44AM +0200, Jonas Smedegaard wrote:
> > On 12-07-13 at 08:39pm, Cyril Brulebois wrote:
> > > Jonas Smedegaard <dr@jones.dk> (13/07/2012):
> > > > Please proofread your changelog before releasing a packaging, and make
> > > > sure all entries describe what was _changed_. ^^^^^^^^^
> > >
> > > SNCR,
> > > KiBi.
> >
> > I fail to extract any meaning out of the above.
> > Could you please elaborate?
> It should of been package not packaging. I got that bit.
> Still, I'm not sure what "Stevie Nicks Concert Reviews" or the "Society
> for New Communications Research" has got to do with it.

Shows a sense of humour.

SCNR Sorry, Could Not Resist

--
"If you're not careful, the newspapers will have you hating the people
who are being oppressed, and loving the people who are doing the
oppressing." --- Malcolm X


--
To UNSUBSCRIBE, email to debian-devel-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Archive: http://lists.debian.org/20120714074612.GC3205@tal
 
Old 07-14-2012, 12:06 PM
Chris Bannister
 
Default Package changelog should contain, well, a log of changes

On Sat, Jul 14, 2012 at 07:14:56AM +0000, Sune Vuorela wrote:
> On 2012-07-13, Craig Small <csmall@debian.org> wrote:
> >> On 12-07-13 at 08:39pm, Cyril Brulebois wrote:
> >> > SNCR,
> >> > KiBi.
>
> > It should of been package not packaging. I got that bit.
> > Still, I'm not sure what "Stevie Nicks Concert Reviews" or the "Society
> > for New Communications Research" has got to do with it.
>
> I guess it is short for "Sorry Not Could Resist".
>
> It is most likely due to the following law:
>
> Everytime you correct spelling errors on the internet,
> you have a spelling error in your message correcting it

Although spelling and grammar errors make a product "look" cheap, and
show a lack of respect for the buyer/reader. IMHO.

But times, they are a changin'
http://news.slashdot.org/story/12/07/09/1132201/does-grammar-matter-anymore

--
"If you're not careful, the newspapers will have you hating the people
who are being oppressed, and loving the people who are doing the
oppressing." --- Malcolm X


--
To UNSUBSCRIBE, email to debian-devel-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Archive: http://lists.debian.org/20120714120635.GB8057@tal
 

Thread Tools




All times are GMT. The time now is 10:36 PM.

VBulletin, Copyright ©2000 - 2014, Jelsoft Enterprises Ltd.
Content Relevant URLs by vBSEO ©2007, Crawlability, Inc.
Copyright 2007 - 2008, www.linux-archive.org