linux-kernel - Re: [PATCH v2] 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] [day] [month] [year] [list]

Message-ID: <20250504174941.1390b21b@jic23-huawei>
Date: Sun, 4 May 2025 17:49:41 +0100
From: Jonathan Cameron <jic23@...nel.org>
To: Chelsy Ratnawat <chelsyratnawat2001@...il.com>
Cc: jikos@...nel.org, bentiss@...nel.org,
 srinivas.pandruvada@...ux.intel.com, dlechner@...libre.com,
 linux-input@...r.kernel.org, linux-iio@...r.kernel.org,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] HID: sensor-hub: Fix typo and improve documentation
 for sensor_hub_remove_callback()

On Thu,  1 May 2025 17:36:55 -0700
Chelsy Ratnawat <chelsyratnawat2001@...il.com> 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>
> Reviewed-by: David Lechner <dlechner@...libre.com>
> ---
Even though trivial reason for resend, this is v3.

Posting it as v2 confuses some tooling such as b4.
I manually grabbed the right patch and applied.

Thanks,

Jonathan

> Changes in v2:
>  - Improved the kernel-doc comment for sensor_hub_remove_callback().
>  - Changed "Gyro" to "gyro".
>  - Changed "usage ID" to "usage_id" for consistency with kernel-doc
>    style.
>  - Updated the comment to state that only one callback can be removed
>    per (usage_id, hsdev) pair.
> 
>  include/linux/hid-sensor-hub.h | 9 +++++----
>  1 file changed, 5 insertions(+), 4 deletions(-)
> 
> diff --git a/include/linux/hid-sensor-hub.h b/include/linux/hid-sensor-hub.h
> index c27329e2a5ad..0f9f7df865db 100644
> --- a/include/linux/hid-sensor-hub.h
> +++ b/include/linux/hid-sensor-hub.h
> @@ -128,12 +128,13 @@ int sensor_hub_register_callback(struct hid_sensor_hub_device *hsdev,
>  			struct hid_sensor_hub_callbacks *usage_callback);
>  
>  /**
> -* sensor_hub_remove_callback() - Remove client callbacks
> +* sensor_hub_remove_callback() - Remove client callback
>  * @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).
>  *
> -* 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
> +* and hsdev. Once removed, the client will no longer receive data or
> +* event notifications.
>  */
>  int sensor_hub_remove_callback(struct hid_sensor_hub_device *hsdev,
>  			u32 usage_id);