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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxx>

Thanks,
Armin Wolf

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Cc: Armin Wolf <W_Armin@xxxxxx>
Cc: Hans de Goede <hdegoede@xxxxxxxxxx>
Cc: Ilpo Järvinen <ilpo.jarvinen@xxxxxxxxxxxxxxx>
Cc: platform-driver-x86@xxxxxxxxxxxxxxx
---
  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;
  };






[Index of Archives]     [Linux Kernel Development]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux