linux-kernel - Re: [PATCH] platform/x86: wmi: linux/wmi.h: fix Excess kernel-doc description warning

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: <1dd56bfa-ce60-4037-bb1e-0d1676d4e8ce@gmx.de>
Date: Sat, 23 Dec 2023 07:48:18 +0100
From: Armin Wolf <W_Armin@....de>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: Hans de Goede <hdegoede@...hat.com>,
 Ilpo Järvinen <ilpo.jarvinen@...ux.intel.com>,
 platform-driver-x86@...r.kernel.org
Subject: Re: [PATCH] platform/x86: wmi: linux/wmi.h: fix Excess kernel-doc
 description warning

Am 23.12.23 um 06:06 schrieb Randy Dunlap:

> Remove the "private:" comment to prevent the kernel-doc warning:
>
> include/linux/wmi.h:27: warning: Excess struct member 'setable' description in 'wmi_device'
>
> Either a struct member is documented (via kernel-doc) or it's private,
> but not both.

Hi,

i am not encountering this kernel doc warning, but your argument is still valid. I also seem to
have missed the fact that WMI drivers may want to know whether their WMI data block is setable
during runtime when i added those kernel-doc comments.

Please add a Fixes: b4cc979588ee ("platform/x86: wmi: Add kernel doc comments") tag so that
this patch can reach the stable kernels. With that addressed, you may also add:

Reviewed-by: Armin Wolf <W_Armin@....de>

Thanks,
Armin Wolf

> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Armin Wolf <W_Armin@....de>
> Cc: Hans de Goede <hdegoede@...hat.com>
> Cc: Ilpo Järvinen <ilpo.jarvinen@...ux.intel.com>
> Cc: platform-driver-x86@...r.kernel.org
> ---
>   include/linux/wmi.h |    2 --
>   1 file changed, 2 deletions(-)
>
> diff -- a/include/linux/wmi.h b/include/linux/wmi.h
> --- a/include/linux/wmi.h
> +++ b/include/linux/wmi.h
> @@ -21,8 +21,6 @@
>    */
>   struct wmi_device {
>   	struct device dev;
> -
> -	/* private: used by the WMI driver core */
>   	bool setable;
>   };
>