linux-kernel - Re: [PATCH] HID: sensor-hub: Fix typo and improve documentation for sensor_hub_remove

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <3717e8d0bfc058739b3333931ba6c39d55d2d383.camel@linux.intel.com>
Date: Thu, 01 May 2025 16:21:36 -0700
From: srinivas pandruvada <srinivas.pandruvada@...ux.intel.com>
To: David Lechner <dlechner@...libre.com>, Chelsy Ratnawat
	 <chelsyratnawat2001@...il.com>, jikos@...nel.org, jic23@...nel.org, 
	bentiss@...nel.org
Cc: linux-input@...r.kernel.org, linux-iio@...r.kernel.org, 
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH] HID: sensor-hub: Fix typo and improve documentation for
 sensor_hub_remove_callback()

On Wed, 2025-04-30 at 14:17 -0500, David Lechner wrote:
> On 4/30/25 1:23 PM, Chelsy Ratnawat wrote:
> > Fixed a typo in "registered" and improved grammar for better
> > readability
> > and consistency with kernel-doc standards. No functional changes.
> > 
> > Signed-off-by: Chelsy Ratnawat <chelsyratnawat2001@...il.com>
> > ---
> >  include/linux/hid-sensor-hub.h | 7 ++++---
> >  1 file changed, 4 insertions(+), 3 deletions(-)
> > 
> > diff --git a/include/linux/hid-sensor-hub.h b/include/linux/hid-
> > sensor-hub.h
> > index c27329e2a5ad..5d2ac79429d4 100644
> > --- a/include/linux/hid-sensor-hub.h
> > +++ b/include/linux/hid-sensor-hub.h
> > @@ -130,10 +130,11 @@ int sensor_hub_register_callback(struct
> > hid_sensor_hub_device *hsdev,
> >  /**
> >  * sensor_hub_remove_callback() - Remove client callbacks
> 
> This says "callbacks", so is it possible to have more than one
> registered at a
> time?

This removes only one. So "callback" will be correct.

Thanks,
Srinivas


> 
> >  * @hsdev:	Hub device instance.
> > -* @usage_id:	Usage id of the client (E.g. 0x200076 for Gyro).
> > +* @usage_id:	Usage id of the client (e.g. 0x200076 for Gyro).
> 
> should we also make gyro lower-case?
> 
> >  *
> > -* If there is a callback registred, this call will remove that
> > -* callbacks, so that it will stop data and event notifications.
> > +* Removes a previously registered callback for the given usage ID.
> > +* Once removed, the client will no longer receive data or event
> > +* notifications.
> 
> I like the revised wording, but possibly looses some clarity that
> could be
> fixed with:
> 
> Removes a previously registered callback(s), if any, for the given
> usage ID.
> 
> As above, not sure if singular or plural callbacks is correct.
> 
> >  */
> >  int sensor_hub_remove_callback(struct hid_sensor_hub_device
> > *hsdev,
> >  			u32 usage_id);
>