Re: [v3, 09/12] hwmon (occ): Add sensor attributes and register hwmon device

From: Guenter Roeck
Date: Wed Nov 22 2017 - 10:22:44 EST


On Mon, Nov 20, 2017 at 05:53:38PM -0600, eajames@xxxxxxxxxxxxxxxxxx wrote:
> From: "Edward A. James" <eajames@xxxxxxxxxx>
>
> Setup the sensor attributes for every OCC sensor found by the first poll
> response. Register the attributes with hwmon. Add hwmon documentation
> for the driver.
>
> Signed-off-by: Edward A. James <eajames@xxxxxxxxxx>
> ---
> drivers/hwmon/occ/common.c | 450 +++++++++++++++++++++++++++++++++++++++++++++
> drivers/hwmon/occ/common.h | 15 ++

I seem to be missing the documentation.

Documentation/hwmon/submitting-patches:

* Document the driver in Documentation/hwmon/<driver_name>.

* Do not create non-standard attributes unless really needed. If you have to use
non-standard attributes, or you believe you do, discuss it on the mailing list
first. Either case, provide a detailed explanation why you need the
non-standard attribute(s).
Standard attributes are specified in Documentation/hwmon/sysfs-interface.

I really would expect a detailed explanation and, even more so,
documentation for all the non-standard attributes you are adding.

power%d_update_time
power%d_update_tag
power%d_accumulator

really need to be documented, you really need to explain the need for those
attributes. To me they don't mean anything.

Note that you'd probably be much better off using
devm_register_hwmon_with_info() nowadays, but i'll leave that for you to
decide.

Guenter