public inbox for linux-hwmon@vger.kernel.org
 help / color / mirror / Atom feed
From: Guenter Roeck <linux@roeck-us.net>
To: eajames@linux.vnet.ibm.com
Cc: linux-kernel@vger.kernel.org, linux-hwmon@vger.kernel.org,
	devicetree@vger.kernel.org, linux-doc@vger.kernel.org,
	jdelvare@suse.com, corbet@lwn.net, mark.rutland@arm.com,
	robh+dt@kernel.org, joel@jms.id.au,
	"Edward A. James" <eajames@us.ibm.com>
Subject: Re: [v3, 09/12] hwmon (occ): Add sensor attributes and register hwmon device
Date: Wed, 22 Nov 2017 07:22:37 -0800	[thread overview]
Message-ID: <20171122152237.GA20324@roeck-us.net> (raw)
In-Reply-To: <1511222021-562-10-git-send-email-eajames@linux.vnet.ibm.com>

On Mon, Nov 20, 2017 at 05:53:38PM -0600, eajames@linux.vnet.ibm.com wrote:
> From: "Edward A. James" <eajames@us.ibm.com>
> 
> 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@us.ibm.com>
> ---
>  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

  reply	other threads:[~2017-11-22 15:22 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-20 23:53 [PATCH v3 00/12] hwmon: Add On-Chip Controller hwmon driver Eddie James
2017-11-20 23:53 ` [PATCH v3 01/12] Documentation: hwmon: Add OCC documentation Eddie James
2017-11-20 23:53 ` [PATCH v3 02/12] Documentation: ABI: Add occ-hwmon driver sysfs documentation Eddie James
2017-11-22 15:15   ` [v3, " Guenter Roeck
2017-11-20 23:53 ` [PATCH v3 03/12] dt-bindings: i2c: Add P8 OCC hwmon device documentation Eddie James
2017-11-21 18:34   ` Rob Herring
2017-11-20 23:53 ` [PATCH v3 04/12] dt-bindings: fsi: Add P9 " Eddie James
2017-11-21 18:36   ` Rob Herring
2017-11-20 23:53 ` [PATCH v3 05/12] hwmon: Add On-Chip Controller (OCC) hwmon driver Eddie James
2017-11-20 23:53 ` [PATCH v3 06/12] hwmon (occ): Add command transport method for P8 and P9 Eddie James
2017-11-20 23:53 ` [PATCH v3 07/12] hwmon (occ): Parse OCC poll response Eddie James
2017-11-20 23:53 ` [PATCH v3 08/12] hwmon (occ): Add sensor types and versions Eddie James
2017-11-20 23:53 ` [PATCH v3 09/12] hwmon (occ): Add sensor attributes and register hwmon device Eddie James
2017-11-22 15:22   ` Guenter Roeck [this message]
2017-11-20 23:53 ` [PATCH v3 10/12] hwmon (occ): Add non-hwmon attributes Eddie James
2017-11-22 15:23   ` [v3,10/12] " Guenter Roeck
2017-11-20 23:53 ` [PATCH v3 11/12] hwmon (occ): Add error handling Eddie James
2017-11-20 23:53 ` [PATCH v3 12/12] hwmon (occ): Add sysfs notification for errors and throttling Eddie James

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20171122152237.GA20324@roeck-us.net \
    --to=linux@roeck-us.net \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=eajames@linux.vnet.ibm.com \
    --cc=eajames@us.ibm.com \
    --cc=jdelvare@suse.com \
    --cc=joel@jms.id.au \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=robh+dt@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox