Thread (3 messages) 3 messages, 2 authors, 2021-06-15

Re: [PATCH -next] ACPI: sysfs: fix doc warnings in device_sysfs.c

From: libaokun (A) <hidden>
Date: 2021-06-15 03:50:19
Also in: lkml

在 2021/6/14 23:26, Rafael J. Wysocki 写道:
On Thu, Jun 10, 2021 at 1:25 PM Baokun Li [off-list ref] wrote:
quoted
Fixes the following W=1 kernel build warning(s):

  drivers/acpi/device_sysfs.c:278: warning: Function parameter or
   member 'dev' not described in 'acpi_device_uevent_modalias'
  drivers/acpi/device_sysfs.c:278: warning: Function parameter or
   member 'env' not described in 'acpi_device_uevent_modalias'
  drivers/acpi/device_sysfs.c:323: warning: Function parameter or
   member 'dev' not described in 'acpi_device_modalias'
  drivers/acpi/device_sysfs.c:323: warning: Function parameter or
   member 'buf' not described in 'acpi_device_modalias'
  drivers/acpi/device_sysfs.c:323: warning: Function parameter or
   member 'size' not described in 'acpi_device_modalias'

Signed-off-by: Baokun Li <redacted>
---
  drivers/acpi/device_sysfs.c | 7 +++++--
  1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/drivers/acpi/device_sysfs.c b/drivers/acpi/device_sysfs.c
index fa2c1c93072c..3b08efa88ba5 100644
--- a/drivers/acpi/device_sysfs.c
+++ b/drivers/acpi/device_sysfs.c
@@ -268,7 +268,8 @@ int __acpi_device_uevent_modalias(struct acpi_device *adev,

  /**
   * acpi_device_uevent_modalias - uevent modalias for ACPI-enumerated devices.
- *
+ * @dev: Struct device.
+ * @env: Uevent kobject.
This doesn't appear to be accurate.

@env doesn't point to a kobject.
I didn't quite understand that variable.

But I saw the same paramter in  'drivers/misc/mei/bus.c +1001' where has 
comments.

So I copied that comments here.


  997 /**
  998  * mei_cl_device_uevent - me client bus uevent handler
  999  *
1000  * @dev: device
1001  * @env: uevent kobject
1002  *
1003  * Return: 0 on success -ENOMEM on when add_uevent_var fails
1004  */
1005 static int mei_cl_device_uevent(struct device *dev, struct 
kobj_uevent_env *env)


Thank you for your advice.

I'm about to send a patch v2 with the changes suggested by you.

Best Regards.

quoted
   * Create the uevent modalias field for ACPI-enumerated devices.
   *
   * Because other buses do not support ACPI HIDs & CIDs, e.g. for a device with
@@ -313,7 +314,9 @@ static int __acpi_device_modalias(struct acpi_device *adev, char *buf, int size)

  /**
   * acpi_device_modalias - modalias sysfs attribute for ACPI-enumerated devices.
- *
+ * @dev: Struct device.
+ * @buf: The buffer.
+ * @size: Size of the buffer.
   * Create the modalias sysfs attribute for ACPI-enumerated devices.
   *
   * Because other buses do not support ACPI HIDs & CIDs, e.g. for a device with
--
2.31.1
.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help