Re: [PATCH v3 02/41] dmaengine: at_hdmac: convert callback to helper function

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 07/19/2016 08:42 PM, Jiang, Dave wrote:
>> -----Original Message-----
>> From: dmaengine-owner@xxxxxxxxxxxxxxx [mailto:dmaengine-owner@xxxxxxxxxxxxxxx] On Behalf Of Jiang, Dave
>> Sent: Tuesday, July 19, 2016 11:20 AM
>> To: Lars-Peter Clausen <lars@xxxxxxxxxx>; Koul, Vinod <vinod.koul@xxxxxxxxx>
>> Cc: dmaengine@xxxxxxxxxxxxxxx; Williams, Dan J <dan.j.williams@xxxxxxxxx>; Nicolas Ferre <nicolas.ferre@xxxxxxxxx>;
>> laurent.pinchart@xxxxxxxxxxxxxxxx
>> Subject: RE: [PATCH v3 02/41] dmaengine: at_hdmac: convert callback to helper function
>>
>>> -----Original Message-----
>>> From: Lars-Peter Clausen [mailto:lars@xxxxxxxxxx]
>>> Sent: Tuesday, July 19, 2016 11:16 AM
>>> To: Jiang, Dave <dave.jiang@xxxxxxxxx>; Koul, Vinod <vinod.koul@xxxxxxxxx>
>>> Cc: dmaengine@xxxxxxxxxxxxxxx; Williams, Dan J <dan.j.williams@xxxxxxxxx>; Nicolas Ferre <nicolas.ferre@xxxxxxxxx>;
>>> laurent.pinchart@xxxxxxxxxxxxxxxx
>>> Subject: Re: [PATCH v3 02/41] dmaengine: at_hdmac: convert callback to helper function
>>>
>>> On 07/18/2016 11:47 PM, Dave Jiang wrote:
>>>> Convert driver to use the new helper function for callback
>>>
>>> I'd still like to see a proper commit message for the transformation
>>> patches. You know what this is about, I know what this is about, somebody
>>> reading the log in 2-3 years will have no idea.
>>
>> Ok I'll fix that up.
> 
> You want a more verbose commit message for patch 1/41 and 36/41 for the two transformation patches and not all the drivers patches correct? Just want to clarify. 

Every patch should have a proper commit message explaining what is done, how
it is done and why it is done. Somebody looking at the commit log should be
able to get a basic understanding what is going on without having to dig
through the mailing list archives to find the original discussions.

E.g. if I read "Convert driver to use the new helper function for callback"
I'd immediately ask "why? What is the advantage of using the helper functions?"

The commit message should provide additional information to the commit. This
is not the case here, it is fairly obvious looking at the change that it
converts the driver to using the helper functions. In addition to that the
same information is also in the commit title, so all in all the commit
message itself is pretty redundant in its current form. What is not obvious
from the change though is why it is done, this is what the commit message
should explain.

- Lars

--
To unsubscribe from this list: send the line "unsubscribe dmaengine" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Linux Kernel]     [Linux ARM (vger)]     [Linux ARM MSM]     [Linux Omap]     [Linux Arm]     [Linux Tegra]     [Fedora ARM]     [Linux for Samsung SOC]     [eCos]     [Linux PCI]     [Linux Fastboot]     [Gcc Help]     [Git]     [DCCP]     [IETF Announce]     [Security]     [Linux MIPS]     [Yosemite Campsites]

  Powered by Linux