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: <20210615071914.3067407-1-libaokun1@huawei.com>
In-Reply-To: <20210615071914.3067407-1-libaokun1@huawei.com>
From:   "Rafael J. Wysocki" <rafael@kernel.org>
Date:   Thu, 17 Jun 2021 14:34:43 +0200
Message-ID: <CAJZ5v0iMGTDAbY+JivBFRP6soTC5v_imqWZ9jSZoQVeYdgVoCw@mail.gmail.com>
Subject: Re: [PATCH -next v2] ACPI: sysfs: fix doc warnings in device_sysfs.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 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!