On Wed, Aug 6, 2008 at 2:14 PM, Mike Frysinger <vapier.adi@gmail.com> wrote:
Hm. I agree that git/eclipse/emacs/etc. information is not very
useful. However...
For errors found with lockdep, we usually put either the lockdep
output in the commit message or say that it was found with lockdep.
Having this information in the log is useful because it also
establishes a track record for the tool which was used to discover/fix
the error.
Arguably, the semantic patch itself should be present in the log as
well. There are different practices here, but in this case, the patch
was quite long, and has already been included in a pending commit. Now
others may use the same semantic patch (or a variation of it) and
possibly find more "bad" code (possibly introduced after the semantic
patch was first applied!).
It seems that the practice of including a reference to the tool is
already widespread, though, for example:
$ git log v2.6.26-rc2 | grep -ci 'semantic patch'
72
$ git log v2.6.26-rc2 | grep -ci coverity
495
etc.
Vegard
PS: This is a bit of a sore spot for me having been directly involved
with the development of another such tool (kmemcheck). I will always
ask for kmemcheck to be credited in the log whenever it is used to
find and fix genuine programmer errors, simply because that's the best
way to measure its usefulness :-)
--
"The animistic metaphor of the bug that maliciously sneaked in while
the programmer was not looking is intellectually dishonest as it
disguises that the error is the programmer's own creation."
-- E. W. Dijkstra, EWD1036
--