public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Russell Haley <yumpusamongus@gmail.com>
To: james@equiv.tech
Cc: corbet@lwn.net, jdelvare@suse.com, linux-doc@vger.kernel.org,
	linux-hwmon@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux@roeck-us.net
Subject: Re: [RFC 03/11] hwmon: (core) Revise kerneldoc comments
Date: Tue, 25 Jul 2023 18:51:44 -0500	[thread overview]
Message-ID: <11603db1-97c7-cfa0-ab1e-dbf5225ea6eb@gmail.com> (raw)
In-Reply-To: <20230504075752.1320967-4-james@equiv.tech>

> @@ -888,18 +891,25 @@ hwmon_device_register_with_groups(struct device *dev, const char *name,
>  EXPORT_SYMBOL_GPL(hwmon_device_register_with_groups);
>  
>  /**
> - * hwmon_device_register_with_info - register w/ hwmon
> - * @dev: the parent device (mandatory)
> - * @name: hwmon name attribute (mandatory)
> - * @drvdata: driver data to attach to created device (optional)
> - * @chip: pointer to hwmon chip information (mandatory)
> - * @extra_groups: pointer to list of additional non-standard attribute groups
> - *	(optional)
> + * hwmon_device_register_with_info - Register a hardware monitoring device.
> + * @dev: A pointer to the parent device (mandatory).
> + * @name: The ``hwmon`` device name (mandatory).
> + * @drvdata: A pointer to the private driver data structure.
> + * @chip: A pointer to the chip descriptor (mandatory).
> + * @extra_groups: A pointer to a ``NULL``-terminated list of additional
> + *	non-standard ``sysfs`` attribute groups.

This function has no @groups parameter, only @extra_groups.

>   *
> - * hwmon_device_unregister() must be called when the device is no
> - * longer needed.
> + * Creates the standard ``sysfs`` attributes in the hardware monitoring core,
> + * letting the driver focus on reading from and writing to the chip instead of
> + * having to bother with ``sysfs`` attributes.
>   *
> - * Returns the pointer to the new device.
> + * The result is a newly allocated ``hwmon`` device with standard ``sysfs``
> + * attributes as specified by @name and @groups and additional attributes as

But here a @groups parameter is mentioned.

> + * specified by @extra_groups.
> + *
> + * Return: On success, a pointer to the new ``hwmon`` device.
> + * hwmon_device_unregister() must be called on it when it is no longer needed.
> + * On failure, a &PTR_ERR.
>   */
>  struct device *
>  hwmon_device_register_with_info(struct device *dev, const char *name,


  reply	other threads:[~2023-07-25 23:51 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-04  7:57 [RFC 00/11] hwmon: Modernize documentation James Seo
2023-05-04  7:57 ` [RFC 01/11] Documentation/hwmon: Move misplaced entry in hwmon docs index James Seo
2023-05-05  4:58   ` Bagas Sanjaya
2023-05-06 13:43   ` Guenter Roeck
2023-05-04  7:57 ` [RFC 02/11] hwmon: (core) Rename last parameter of devm_hwmon_register_with_info() James Seo
2023-05-04 15:29   ` Guenter Roeck
2023-05-05 13:15     ` James Seo
2023-05-05 13:30       ` Guenter Roeck
2023-05-05 14:39         ` James Seo
2023-05-04  7:57 ` [RFC 03/11] hwmon: (core) Revise kerneldoc comments James Seo
2023-07-25 23:51   ` Russell Haley [this message]
2023-05-04  7:57 ` [RFC 04/11] Documentation/hwmon: Revise hwmon kernel API reference James Seo
2023-05-05  4:12   ` Bagas Sanjaya
2023-05-05  4:20   ` Bagas Sanjaya
2023-05-05 13:29     ` James Seo
2023-05-06 13:52   ` Guenter Roeck
2023-05-07 14:40     ` James Seo
2023-05-04  7:57 ` [RFC 05/11] Documentation/hwmon: Revise PMBus core documentation James Seo
2023-05-05  4:27   ` Bagas Sanjaya
2023-05-05  4:32     ` Guenter Roeck
2023-05-05 13:35     ` James Seo
2023-05-04  7:57 ` [RFC 06/11] Documentation/hwmon: Revise patch submission checklist James Seo
2023-05-05  4:34   ` Bagas Sanjaya
2023-05-05 14:50     ` James Seo
2023-05-04  7:57 ` [RFC 07/11] Documentation/hwmon: Revise sysfs interface specification James Seo
2023-05-05  4:51   ` Bagas Sanjaya
2023-05-05 15:01     ` James Seo
2023-05-05 15:10       ` Jonathan Corbet
2023-05-04  7:57 ` [RFC 08/11] Documentation/hwmon: Revise userspace tools documentation James Seo
2023-05-05  5:03   ` Bagas Sanjaya
2023-05-05 15:12     ` James Seo
2023-05-05 21:10       ` Guenter Roeck
2023-05-04  7:57 ` [RFC 09/11] ABI: sysfs-class-hwmon: Revise hwmon ABI documentation James Seo
2023-05-04  7:57 ` [RFC 10/11] hwmon: (core) Add missing beep-related standard attributes James Seo
2023-05-04  7:57 ` [RFC 11/11] ABI: sysfs-class-hwmon: Add missing hwmon " James Seo

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=11603db1-97c7-cfa0-ab1e-dbf5225ea6eb@gmail.com \
    --to=yumpusamongus@gmail.com \
    --cc=corbet@lwn.net \
    --cc=james@equiv.tech \
    --cc=jdelvare@suse.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    /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