[Development] ChangeLogs

[Thiago Macieira]

On sexta-feira, 18 de janeiro de 2013 09.54.37, Eskil Abrahamsen Blomfeldt 
wrote:
> Having it as part of the commit message seems a lot less complex to me, 
> and I don't think it would do any harm to an extra line of 
> meta-information in the bottom section with the change-id and 
> task-number where there's already lots of clutter.

It's not always just one line. We're talking about a paragraph.

Here's what a commit message would look like, if I had used that for the 
commit I've just pushed:

===
Clear the current thread data for the main thread

This avoids crashes accessing deleted memory when creating a QObject
after the last QObject had been deleted, like a qDebug() in global
destructors.

==41000== Invalid read of size 4
==41000==    at 0x5F01ED5: bool QBasicAtomicOps<4>::ref<int>(int&) 
(qatomic_x86.h:208)
==41000==    by 0x5F01309: QBasicAtomicInteger<int>::ref() 
(qbasicatomic.h:147)
==41000==    by 0x5F24051: QThreadData::ref() (qthread.cpp:100)
==41000==    by 0x614A984: QObject::QObject(QObject*) (qobject.cpp:681)
==41000==  Address 0x6ee73f0 is 0 bytes inside a block of size 152 free'd
==41000==    at 0x4A0736C: operator delete(void*) (vg_replace_malloc.c:480)
==41000==    by 0x5F240BF: QThreadData::deref() (qthread.cpp:109)
==41000==    by 0x6113F6B: QCoreApplicationData::~QCoreApplicationData() 
(qcoreapplication.cpp:268)

ChangeLog: Fixed a crash that would cause the QObject constructor to crash if 
it was run during application shut down (that is, in global destructors).

Change-Id: I0dba895b041fe6cf81e6f8939ca85035cd00aad1
===

Note how it's repeating information that was already present in the commit 
message (it's redundant), just in a different way. Also note how the change log 
is not a line, but a longer sentence.
-- 
Thiago Macieira - thiago.macieira (AT) intel.com
  Software Architect - Intel Open Source Technology Center
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 190 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.qt-project.org/pipermail/development/attachments/20130118/fb44bfbf/attachment.sig>