Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20210608023733.2745553-1-libaokun1@huawei.com>
In-Reply-To: <20210608023733.2745553-1-libaokun1@huawei.com>
From:   "Rafael J. Wysocki" <rafael@kernel.org>
Date:   Wed, 9 Jun 2021 15:09:18 +0200
Message-ID: <CAJZ5v0hRqKM7GrcSuxT=7-E3EhtZ+nmrpeTaAdUijSZ2s2APmg@mail.gmail.com>
Subject: Re: [PATCH -next] acpi/bus: fix doc warnings in bus.c
To:     Baokun Li <libaokun1@huawei.com>
Cc:     "Rafael J. Wysocki" <rjw@rjwysocki.net>,
        Len Brown <lenb@kernel.org>,
        ACPI Devel Maling List <linux-acpi@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        Wei Yongjun <weiyongjun1@huawei.com>,
        Yue Haibing <yuehaibing@huawei.com>, yangjihong1@huawei.com,
        yu kuai <yukuai3@huawei.com>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Tue, Jun 8, 2021 at 4:28 AM Baokun Li <libaokun1@huawei.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@huawei.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
>