Re: [Outreachy kernel] [PATCH v2 1/2] Staging: rtl8192u: Do not add new typedefs

[Jes Sorensen <jes.sorensen@gmail.com>]

On 03/17/15 12:47, Julia Lawall wrote:
> 
> 
> On Tue, 17 Mar 2015, Jes Sorensen wrote:
> 
>> On 03/16/15 15:55, Cristina Opriceana wrote:
>>> This patch removes the dig_t and DRxPathSel type definitions in order to
>>> avoid the following warning: "WARNING: Do not add new typedefs".
>>> Done with coccinelle and this script:
>>>
>>> @r@ type t; identifier id; @@
>>> typedef struct id
>>> {...}
>>> t;
>>>
>>> @script:python get_name@
>>> t << r.t;
>>> tdres;
>>> @@
>>> coccinelle.tdres = t.replace("_t", "");
>>>
>>> @r_match@ type r.t; identifier r.id;
>>> identifier get_name.tdres; @@
>>> -typedef
>>> struct
>>> -id
>>> +tdres
>>> {...}
>>> -t
>>> ;
>>> @r_replace@ type r.t; identifier get_name.tdres; @@
>>> -t
>>> +struct tdres
>>>
>>> Signed-off-by: Cristina Opriceana <cristina.opriceana@gmail.com>
>>
>> Removing pointless typedefs like these is clearly a win. However for
>> something like this, I don't think you need to include the coccinnelle
>> rules, simply stating that you are getting rid of unnecessary typedefs
>> is a win.
> 
> Actually, I think the rule is nice, because we can see that she is taking
> care of the _t before looking at each case.  I would tend to put a
> complete rule like this in a cover letter though, but it depends on how
> the patch series is organized.

There is definitely a level of personal preference here. IMHO the rule
doesn't add value to the commit log, since it doesn't deal with an
actual bug. Having it in a cover-letter would be fine.

Cheers,
Jes