[PATCH linux dev-4.10 v4 0/2] hwmon: (ucd9000) Add gpio and debugfs

Andrew Jeffery andrew at aj.id.au
Tue Aug 22 12:00:41 AEST 2017


Hi Chris,

On Mon, 2017-08-21 at 17:09 -0500, Christopher Bostic wrote:
> Add GPIO chip for user space access of the device's IO.
> Add debugfs for register dump of mfr_status and individual gpi
> faults.
> Add sysfs attribute to clear logged faults.

In general my preference for cover letters, similar to commit messages, is they
should describe the why and not the what. However, unlike the individual commit
messages, the cover letter should address the motivation for the series as a
whole, synthesising the information in the commit messages and discussing
issues that don't make sense for any one commit message.

Again ideally, and in general, the cover letter should call out different
classes of patches if necessary (e.g. "Patches 1-3 fix bugs, patch 4 adds
feature X, patch 5 integrates X into Y"). If features been implemented in ways
that might be controversial it helps to point that out too (and discuss design
choices).

Essentially the cover letter should be your guide for reviewers on how to most
effectively review your patches. This is why I don't find just listing the
"what" ultimately that helpful - your cover letter is effectively only serving
as a header under which to group the threaded patches. I feel like this is a
missed opportunity.

Cheers,

Andrew

> 
> Christopher Bostic (2):
>   hwmon: (ucd9000) Add gpio chip interface and clear logged faults
>   hwmon: (ucd9000) Add debugfs for mfr_status info
> 
>  drivers/hwmon/pmbus/ucd9000.c | 250
> +++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 248 insertions(+), 2 deletions(-)
> 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 801 bytes
Desc: This is a digitally signed message part
URL: <http://lists.ozlabs.org/pipermail/openbmc/attachments/20170822/5e6c99b0/attachment.sig>


More information about the openbmc mailing list