[PATCH v2] HID: sensor-hub: Fix typo and improve documentation

Chelsy Ratnawat posted 1 patch 7 months, 2 weeks ago
include/linux/hid-sensor-hub.h | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
[PATCH v2] HID: sensor-hub: Fix typo and improve documentation
Posted by Chelsy Ratnawat 7 months, 2 weeks ago
Includes the following corrections -
 - Changed Measurment -> Measurement
 - Changed clode -> close
 - Gyro -> gyro

Signed-off-by: Chelsy Ratnawat <chelsyratnawat2001@gmail.com>
---
Changes in v2 -
 - Changed  X-AXIS -> X-axis

 include/linux/hid-sensor-hub.h | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/include/linux/hid-sensor-hub.h b/include/linux/hid-sensor-hub.h
index 0f9f7df865db..e71056553108 100644
--- a/include/linux/hid-sensor-hub.h
+++ b/include/linux/hid-sensor-hub.h
@@ -17,7 +17,7 @@
  * @attrib_id:		Attribute id for this attribute.
  * @report_id:		Report id in which this information resides.
  * @index:		Field index in the report.
- * @units:		Measurment unit for this attribute.
+ * @units:		Measurement unit for this attribute.
  * @unit_expo:		Exponent used in the data.
  * @size:		Size in bytes for data size.
  * @logical_minimum:	Logical minimum value for this attribute.
@@ -39,8 +39,8 @@ struct hid_sensor_hub_attribute_info {
  * struct sensor_hub_pending - Synchronous read pending information
  * @status:		Pending status true/false.
  * @ready:		Completion synchronization data.
- * @usage_id:		Usage id for physical device, E.g. Gyro usage id.
- * @attr_usage_id:	Usage Id of a field, E.g. X-AXIS for a gyro.
+ * @usage_id:		Usage id for physical device, e.g. gyro usage id.
+ * @attr_usage_id:	Usage Id of a field, e.g. X-axis for a gyro.
  * @raw_size:		Response size for a read request.
  * @raw_data:		Place holder for received response.
  */
@@ -104,10 +104,10 @@ struct hid_sensor_hub_callbacks {
 int sensor_hub_device_open(struct hid_sensor_hub_device *hsdev);
 
 /**
-* sensor_hub_device_clode() - Close hub device
+* sensor_hub_device_close() - Close hub device
 * @hsdev:	Hub device instance.
 *
-* Used to clode hid device for sensor hub.
+* Used to close hid device for sensor hub.
 */
 void sensor_hub_device_close(struct hid_sensor_hub_device *hsdev);
 
-- 
2.43.5
Re: [PATCH v2] HID: sensor-hub: Fix typo and improve documentation
Posted by David Lechner 7 months, 2 weeks ago
On 5/7/25 12:57 AM, Chelsy Ratnawat wrote:
> Includes the following corrections -
>  - Changed Measurment -> Measurement
>  - Changed clode -> close
>  - Gyro -> gyro
> 
> Signed-off-by: Chelsy Ratnawat <chelsyratnawat2001@gmail.com>
> ---
Reviewed-by: David Lechner <dlechner@baylibre.com>
Re: [PATCH v2] HID: sensor-hub: Fix typo and improve documentation
Posted by Jonathan Cameron 7 months, 2 weeks ago
On Wed, 7 May 2025 08:24:48 -0500
David Lechner <dlechner@baylibre.com> wrote:

> On 5/7/25 12:57 AM, Chelsy Ratnawat wrote:
> > Includes the following corrections -
> >  - Changed Measurment -> Measurement
> >  - Changed clode -> close
> >  - Gyro -> gyro
> > 
> > Signed-off-by: Chelsy Ratnawat <chelsyratnawat2001@gmail.com>
> > ---  
> Reviewed-by: David Lechner <dlechner@baylibre.com>
> 

Applied