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

["libaokun (A)" <libaokun1@huawei.com>]

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!
> .