* [PATCH -next v2] ACPI: sysfs: fix doc warnings in device_sysfs.c
@ 2021-06-15 7:19 Baokun Li
2021-06-17 12:34 ` Rafael J. Wysocki
0 siblings, 1 reply; 3+ messages in thread
From: Baokun Li @ 2021-06-15 7:19 UTC (permalink / raw)
To: rjw, lenb, linux-acpi, linux-kernel
Cc: weiyongjun1, yuehaibing, yangjihong1, yukuai3, libaokun1
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 <libaokun1@huawei.com>
---
V1->V2:
Make comments more appropriate
drivers/acpi/device_sysfs.c | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/drivers/acpi/device_sysfs.c b/drivers/acpi/device_sysfs.c
index a393e0e09381..d96e38b2a0d1 100644
--- a/drivers/acpi/device_sysfs.c
+++ b/drivers/acpi/device_sysfs.c
@@ -268,6 +268,8 @@ int __acpi_device_uevent_modalias(struct acpi_device *adev,
/**
* acpi_device_uevent_modalias - uevent modalias for ACPI-enumerated devices.
+ * @dev: Struct device to get acpi device node.
+ * @env: Environment variables of the kobject uevent.
*
* Create the uevent modalias field for ACPI-enumerated devices.
*
@@ -313,6 +315,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 to get acpi device node.
+ * @buf: The buffer to save pnp_modalias and of_modalias.
+ * @size: Size of buffer.
*
* Create the modalias sysfs attribute for ACPI-enumerated devices.
*
--
2.31.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH -next v2] ACPI: sysfs: fix doc warnings in device_sysfs.c
2021-06-15 7:19 [PATCH -next v2] ACPI: sysfs: fix doc warnings in device_sysfs.c Baokun Li
@ 2021-06-17 12:34 ` Rafael J. Wysocki
2021-06-17 12:58 ` libaokun (A)
0 siblings, 1 reply; 3+ messages in thread
From: Rafael J. Wysocki @ 2021-06-17 12:34 UTC (permalink / raw)
To: Baokun Li
Cc: Rafael J. Wysocki, Len Brown, ACPI Devel Maling List,
Linux Kernel Mailing List, Wei Yongjun, Yue Haibing, yangjihong1,
yu kuai
On Tue, Jun 15, 2021 at 9:10 AM Baokun Li <libaokun1@huawei.com> wrote:
>
> 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 <libaokun1@huawei.com>
> ---
> V1->V2:
> Make comments more appropriate
>
> drivers/acpi/device_sysfs.c | 5 +++++
> 1 file changed, 5 insertions(+)
>
> diff --git a/drivers/acpi/device_sysfs.c b/drivers/acpi/device_sysfs.c
> index a393e0e09381..d96e38b2a0d1 100644
> --- a/drivers/acpi/device_sysfs.c
> +++ b/drivers/acpi/device_sysfs.c
> @@ -268,6 +268,8 @@ int __acpi_device_uevent_modalias(struct acpi_device *adev,
>
> /**
> * acpi_device_uevent_modalias - uevent modalias for ACPI-enumerated devices.
> + * @dev: Struct device to get acpi device node.
> + * @env: Environment variables of the kobject uevent.
> *
> * Create the uevent modalias field for ACPI-enumerated devices.
> *
> @@ -313,6 +315,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 to get acpi device node.
> + * @buf: The buffer to save pnp_modalias and of_modalias.
> + * @size: Size of buffer.
> *
> * Create the modalias sysfs attribute for ACPI-enumerated devices.
> *
> --
Applied as 5.14 material with fixed spelling ("acpi" -> "ACPI").
Please always spell ACPI in capitals in comments, patch changelogs,
subjects and similar.
Thanks!
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH -next v2] ACPI: sysfs: fix doc warnings in device_sysfs.c
2021-06-17 12:34 ` Rafael J. Wysocki
@ 2021-06-17 12:58 ` libaokun (A)
0 siblings, 0 replies; 3+ messages in thread
From: libaokun (A) @ 2021-06-17 12:58 UTC (permalink / raw)
To: Rafael J. Wysocki
Cc: Rafael J. Wysocki, Len Brown, ACPI Devel Maling List,
Linux Kernel Mailing List, Wei Yongjun, Yue Haibing, yangjihong1,
yu kuai
Thank you for your advice.
I'll follow your advice strictly.
Best Regards.
在 2021/6/17 20:34, Rafael J. Wysocki 写道:
> On Tue, Jun 15, 2021 at 9:10 AM Baokun Li <libaokun1@huawei.com> wrote:
>> 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 <libaokun1@huawei.com>
>> ---
>> V1->V2:
>> Make comments more appropriate
>>
>> drivers/acpi/device_sysfs.c | 5 +++++
>> 1 file changed, 5 insertions(+)
>>
>> diff --git a/drivers/acpi/device_sysfs.c b/drivers/acpi/device_sysfs.c
>> index a393e0e09381..d96e38b2a0d1 100644
>> --- a/drivers/acpi/device_sysfs.c
>> +++ b/drivers/acpi/device_sysfs.c
>> @@ -268,6 +268,8 @@ int __acpi_device_uevent_modalias(struct acpi_device *adev,
>>
>> /**
>> * acpi_device_uevent_modalias - uevent modalias for ACPI-enumerated devices.
>> + * @dev: Struct device to get acpi device node.
>> + * @env: Environment variables of the kobject uevent.
>> *
>> * Create the uevent modalias field for ACPI-enumerated devices.
>> *
>> @@ -313,6 +315,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 to get acpi device node.
>> + * @buf: The buffer to save pnp_modalias and of_modalias.
>> + * @size: Size of buffer.
>> *
>> * Create the modalias sysfs attribute for ACPI-enumerated devices.
>> *
>> --
> Applied as 5.14 material with fixed spelling ("acpi" -> "ACPI").
>
> Please always spell ACPI in capitals in comments, patch changelogs,
> subjects and similar.
>
> Thanks!
> .
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-06-17 12:58 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-06-15 7:19 [PATCH -next v2] ACPI: sysfs: fix doc warnings in device_sysfs.c Baokun Li
2021-06-17 12:34 ` Rafael J. Wysocki
2021-06-17 12:58 ` libaokun (A)
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).