[PATCH] platform_data/mlxreg: mlxreg.h: fix all kernel-doc warnings

Randy Dunlap posted 1 patch 1 month, 1 week ago
include/linux/platform_data/mlxreg.h |   14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
[PATCH] platform_data/mlxreg: mlxreg.h: fix all kernel-doc warnings
Posted by Randy Dunlap 1 month, 1 week ago
Use the correct kernel-doc format & notation to eliminate
kernel-doc warnings:

Warning: include/linux/platform_data/mlxreg.h:24 Enum value
 'MLX_WDT_TYPE1' not described in enum 'mlxreg_wdt_type'
Warning: include/linux/platform_data/mlxreg.h:24 Enum value
 'MLX_WDT_TYPE2' not described in enum 'mlxreg_wdt_type'
Warning: include/linux/platform_data/mlxreg.h:24 Enum value
 'MLX_WDT_TYPE3' not described in enum 'mlxreg_wdt_type'
Warning: include/linux/platform_data/mlxreg.h:37 bad line:
 PHYs ready / unready state;
Warning: include/linux/platform_data/mlxreg.h:153 struct member 'np'
 not described in 'mlxreg_core_data'
Warning: include/linux/platform_data/mlxreg.h:153 struct member 'hpdev'
 not described in 'mlxreg_core_data'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Hans de Goede <hansg@kernel.org>
Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Cc: Vadim Pasternak <vadimp@nvidia.com>
Cc: platform-driver-x86@vger.kernel.org

 include/linux/platform_data/mlxreg.h |   14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

--- linux-next-20260225.orig/include/linux/platform_data/mlxreg.h
+++ linux-next-20260225/include/linux/platform_data/mlxreg.h
@@ -13,10 +13,10 @@
 /**
  * enum mlxreg_wdt_type - type of HW watchdog
  *
- * TYPE1 HW watchdog implementation exist in old systems.
- * All new systems have TYPE2 HW watchdog.
- * TYPE3 HW watchdog can exist on all systems with new CPLD.
- * TYPE3 is selected by WD capability bit.
+ * @MLX_WDT_TYPE1: HW watchdog implementation in old systems.
+ * @MLX_WDT_TYPE2: All new systems have TYPE2 HW watchdog.
+ * @MLX_WDT_TYPE3: HW watchdog that can exist on all systems with new CPLD.
+ *   TYPE3 is selected by WD capability bit.
  */
 enum mlxreg_wdt_type {
 	MLX_WDT_TYPE1,
@@ -35,7 +35,7 @@ enum mlxreg_wdt_type {
  * @MLXREG_HOTPLUG_LC_SYNCED: entry for line card synchronization events, coming
  *			      after hardware-firmware synchronization handshake;
  * @MLXREG_HOTPLUG_LC_READY: entry for line card ready events, indicating line card
-			     PHYs ready / unready state;
+ *			     PHYs ready / unready state;
  * @MLXREG_HOTPLUG_LC_ACTIVE: entry for line card active events, indicating firmware
  *			      availability / unavailability for the ports on line card;
  * @MLXREG_HOTPLUG_LC_THERMAL: entry for line card thermal shutdown events, positive
@@ -123,8 +123,8 @@ struct mlxreg_hotplug_device {
  * @reg_pwr: attribute power register;
  * @reg_ena: attribute enable register;
  * @mode: access mode;
- * @np - pointer to node platform associated with attribute;
- * @hpdev - hotplug device data;
+ * @np: pointer to node platform associated with attribute;
+ * @hpdev: hotplug device data;
  * @notifier: pointer to event notifier block;
  * @health_cntr: dynamic device health indication counter;
  * @attached: true if device has been attached after good health indication;
Re: [PATCH] platform_data/mlxreg: mlxreg.h: fix all kernel-doc warnings
Posted by Ilpo Järvinen 1 month, 1 week ago
On Wed, 25 Feb 2026 21:12:29 -0800, Randy Dunlap wrote:

> Use the correct kernel-doc format & notation to eliminate
> kernel-doc warnings:
> 
> Warning: include/linux/platform_data/mlxreg.h:24 Enum value
>  'MLX_WDT_TYPE1' not described in enum 'mlxreg_wdt_type'
> Warning: include/linux/platform_data/mlxreg.h:24 Enum value
>  'MLX_WDT_TYPE2' not described in enum 'mlxreg_wdt_type'
> Warning: include/linux/platform_data/mlxreg.h:24 Enum value
>  'MLX_WDT_TYPE3' not described in enum 'mlxreg_wdt_type'
> Warning: include/linux/platform_data/mlxreg.h:37 bad line:
>  PHYs ready / unready state;
> Warning: include/linux/platform_data/mlxreg.h:153 struct member 'np'
>  not described in 'mlxreg_core_data'
> Warning: include/linux/platform_data/mlxreg.h:153 struct member 'hpdev'
>  not described in 'mlxreg_core_data'
> 
> [...]


Thank you for your contribution, it has been applied to my local
review-ilpo-fixes branch. Note it will show up in the public
platform-drivers-x86/review-ilpo-fixes branch only once I've pushed my
local branch there, which might take a while.

The list of commits applied:
[1/1] platform_data/mlxreg: mlxreg.h: fix all kernel-doc warnings
      commit: 3350c2b3f2b8a3b985a020a4ef4f2f050a4b6a1d

--
 i.