linux-kernel - Re: [PATCH -next] ACPI: sysfs: fix doc warnings in device

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAJZ5v0ivf6xN0pd4Ub6YuKCwDUpXLcEZywdT+JPKa=1qTOH-iA@mail.gmail.com>
Date:   Mon, 14 Jun 2021 17:26:33 +0200
From:   "Rafael J. Wysocki" <rafael@...nel.org>
To:     Baokun Li <libaokun1@...wei.com>
Cc:     "Rafael J. Wysocki" <rjw@...ysocki.net>,
        Len Brown <lenb@...nel.org>,
        ACPI Devel Maling List <linux-acpi@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Wei Yongjun <weiyongjun1@...wei.com>,
        Yue Haibing <yuehaibing@...wei.com>, yangjihong1@...wei.com,
        yu kuai <yukuai3@...wei.com>
Subject: Re: [PATCH -next] ACPI: sysfs: fix doc warnings in device_sysfs.c

On Thu, Jun 10, 2021 at 1:25 PM Baokun Li <libaokun1@...wei.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@...wei.com>
> ---
>  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.

>   * 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
>