dev builds
themes manual
device status forums
mailing lists
IRC bugs
dev guide

Rockbox mail archive

Subject: patch commit template

patch commit template

From: Frank Gevaerts <>
Date: Tue, 14 Jul 2009 21:14:37 +0200


In june, at DevCon, we decided to introduce formal commit templates for
patches coming from flyspray, so we can find people who contribute many
patches easily by scanning svn logs. Nothing happened yet, so maybe it's
time someone steps up and makes an actual proposal.

How about something like this:

--- begin commit message ---
This fixes x when y fails to do z

Flyspray: FS#1234
Author: John Doe
--- end commit message ---
(obviously without the begin/end markers)

Of course, if multiple people contributed to the patch, there can be
multiple Author: lines, and if the patch doesn't come from flyspray, the
Flyspray: line can be left out.

I don't think we should require this for normal commits. As said before,
the goal is to find people who possibly should become committers.

I think we should also use the same Flyspray: lines when committing fixes
for bugs that are listed on flyspray.



"Debugging is twice as hard as writing the code in the first place.
Therefore, if you write the code as cleverly as possible, you are,
by definition, not smart enough to debug it." - Brian W. Kernighan
Received on 2009-07-14

Page template was last modified "Tue Sep 7 00:00:02 2021" The Rockbox Crew -- Privacy Policy