linux-kernel - Re: [PATCH v2] 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] [day] [month] [year] [list]

Message-ID: <14940411-0da9-45bf-ba88-d3bd3b3c643f@redhat.com>
Date: Tue, 2 Jan 2024 13:37:37 +0100
From: Hans de Goede <hdegoede@...hat.com>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: Armin Wolf <W_Armin@....de>, Ilpo Järvinen
 <ilpo.jarvinen@...ux.intel.com>, platform-driver-x86@...r.kernel.org
Subject: Re: [PATCH v2] platform/x86: wmi: linux/wmi.h: fix Excess kernel-doc
 description warning

Hi,

On 12/23/23 20:43, Randy Dunlap wrote:
> 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.
> 
> Fixes: b4cc979588ee ("platform/x86: wmi: Add kernel doc comments")
> 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
> Reviewed-by: Armin Wolf <W_Armin@....de>
> ---
> v2: add Fixes: tag and Rev-by: Armin


Thank you for your patch, I've applied this patch to my review-hans 
branch:
https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans

Note it will show up in my review-hans branch once I've pushed my
local branch there, which might take a while.

Once I've run some tests on this branch the patches there will be
added to the platform-drivers-x86/for-next branch and eventually
will be included in the pdx86 pull-request to Linus for the next
merge-window.

Regards,

Hans



> 
>  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;
>  };
>  
>