linux-kernel - Re: [PATCH -next] acpi/bus: fix doc warnings in bus.c

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

Message-ID: <CAJZ5v0hRqKM7GrcSuxT=7-E3EhtZ+nmrpeTaAdUijSZ2s2APmg@mail.gmail.com>
Date:   Wed, 9 Jun 2021 15:09:18 +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/bus: fix doc warnings in bus.c

On Tue, Jun 8, 2021 at 4:28 AM Baokun Li <libaokun1@...wei.com> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
>  drivers/acpi/bus.c:437: warning: Function parameter or
>   member 'handle' not described in 'acpi_bus_notify'
>  drivers/acpi/bus.c:437: warning: Function parameter or
>   member 'type' not described in 'acpi_bus_notify'
>  drivers/acpi/bus.c:437: warning: Function parameter or
>   member 'data' not described in 'acpi_bus_notify'
>
> Signed-off-by: Baokun Li <libaokun1@...wei.com>
> ---
>  drivers/acpi/bus.c | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/drivers/acpi/bus.c b/drivers/acpi/bus.c
> index be7da23fad76..021b85ff990a 100644
> --- a/drivers/acpi/bus.c
> +++ b/drivers/acpi/bus.c
> @@ -430,6 +430,9 @@ static void acpi_bus_osc_negotiate_usb_control(void)
>
>  /**
>   * acpi_bus_notify
> + * @handle: Handle to acpi device.
> + * @type: ACPI device event type.
> + * @data: ACPI device data.

This just addresses specific warnings without really fixing the entire
kerneldoc.

Please either fix it entirely, or don't change it.

>   * ---------------
>   * Callback for all 'system-level' device notifications (values 0x00-0x7F).
>   */
> --
> 2.31.1
>