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

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

[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.

Fixes: b4cc979588ee ("platform/x86: wmi: Add kernel doc comments")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Armin Wolf <W_Armin@gmx.de>
Cc: Hans de Goede <hdegoede@redhat.com>
Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Cc: platform-driver-x86@vger.kernel.org
Reviewed-by: Armin Wolf <W_Armin@gmx.de>
---
v2: add Fixes: tag and Rev-by: Armin

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

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

[Hans de Goede]

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@infradead.org>
> Cc: Armin Wolf <W_Armin@gmx.de>
> Cc: Hans de Goede <hdegoede@redhat.com>
> Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
> Cc: platform-driver-x86@vger.kernel.org
> Reviewed-by: Armin Wolf <W_Armin@gmx.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;
>  };
>  
>