I was about to comment on that, I'm glad you did. I would like to add that I disagree with: "This info is ok as part of the longer description but not enough for entire commit message."
Sure, it's OK to mention this, however the point here is that you are not fixing a warning, you are fixing a bug or suppressing a warning. So the info that sholud be provided in the commit message should be about the bug, or why you think there's no bug, and not what was there. As Stefan mentioned, those are seen often. People, please stop. :) -- Tom. On 26/11/13 07:47, Stefan Schmidt wrote: > Hello. > > On Mon, 2013-11-25 at 15:48, Jihoon Kim wrote: >> jihoon pushed a commit to branch master. >> >> http://git.enlightenment.org/core/efl.git/commit/?id=ca16bcbf23196a30e2b9450711c35e17d4b787a0 >> >> commit ca16bcbf23196a30e2b9450711c35e17d4b787a0 >> Author: Jihoon Kim <[email protected]> >> Date: Tue Nov 26 08:48:21 2013 +0900 >> >> fix clang warning in _edje_entry_focus_in_cb > > This is a commit message example I have seen often and would prefer to > get improved. They often are like "Fix warning/error/issue/defect from > $TOOL" > > This info is ok as part of the longer description but not enough for > entire commit message. You need to describe the actual problem you > fixed and not what tool did detect it. An example for this could be > something like this: > > --- > edje_entry: Fix wrong check for error path in _edje_entry_focus_in_cb > > We shoudl only retrun here if we get NULL from _edje_fetch. If we > receive actual data keep processing. > > Found by a clang warning. > --- > > Don't take this as a golden example but it should give you some hints > what was missing and what could get improved. > > regards > Stefan Schmidt > >> --- >> src/lib/edje/edje_entry.c | 2 +- >> 1 file changed, 1 insertion(+), 1 deletion(-) >> >> diff --git a/src/lib/edje/edje_entry.c b/src/lib/edje/edje_entry.c >> index 3c13585..e8afc55 100644 >> --- a/src/lib/edje/edje_entry.c >> +++ b/src/lib/edje/edje_entry.c >> @@ -110,7 +110,7 @@ _edje_entry_focus_in_cb(void *data, Evas_Object *o, >> const char *emission EINA_UN >> if (!rp->typedata.text->entry_data) return; >> >> ed = _edje_fetch(o); >> - if (ed) return; >> + if (!ed) return; >> >> en = rp->typedata.text->entry_data; >> if (!en || !en->imf_context) return; >> >> -- >> >> ------------------------------------------------------------------------------ Shape the Mobile Experience: Free Subscription Software experts and developers: Be at the forefront of tech innovation. Intel(R) Software Adrenaline delivers strategic insight and game-changing conversations that shape the rapidly evolving mobile landscape. Sign up now. http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk _______________________________________________ enlightenment-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
