McEs, A Hacker Life

Tuesday, January 29, 2008

On Bugzilla reference in GNOME ChangeLog's

I've wanted to blog about this for a while...

Those who commit to my modules know, I use a slightly different format to mark bugs in commit messages, and I'm obsessed about it. The format is very simple:


2008-01-28  Behdad Esfahbod  

      Bug 512566 – dont' use deprecated macro
      Patch from Christian Persch

      * tests/test-ot-tags.c:
      * tests/testscript.c:
      Replace G_GNUC_PRETTY_FUNCTION by G_STRFUNC

What's so special about this format is:

Easy to remember which bug it is when reading it. Much more informative than the "(fixes #512566)" standard. I feel free to re-title bugs before fixing them.
Saves typing and my fingers appreciate it! I copy/paste the first line by copying it from bugzilla, with the em-dash and all.
When release time comes, I copy all new ChangeLog entries to my NEWS file and sort them out, collecting all the Bug lines into a "Bugs fixed in this release" section and summarizing the rest of the lines.

So, if you like that, go ahead and use it in your module.

If you don't like it, please be nice enough to obey it in my modules still. You follow coding style of neighboring code when writing a patch. Treat ChangeLog's the same. Thanks.

Labels: bugzilla, ChangeLog, gnome

¶ 11:11 AM 3 comments

Monday, September 17, 2007

gnome-changelog

Dear Lazy Hackers,

Here is my version of prepare-ChangeLog.pl, based on a version I found around the web, with a couple of formatting changes and incomplete git support.

Here is webkit's heavily hacked version of prepare-ChangeLog.pl, apparently based on a separate version and without multiple ChangeLog support as far as I see, but with full git support.

Who is the brave soul / fearless Perl hacker to merge them and create an authentic version and then add it to gnome-common?

I also have a bunch of other gnome scripts I use here.

Thanks,

behdad

Labels: ChangeLog, git, gnome

¶ 10:11 PM 6 comments

About Me

Twitter Updates