Intel-XE Archive on lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] mei: intel_lb_mei_interface.h: mark struct member with kernel-doc
@ 2025-10-16  3:59 Randy Dunlap
  2025-10-16  6:01 ` ✗ CI.checkpatch: warning for " Patchwork
                   ` (5 more replies)
  0 siblings, 6 replies; 8+ messages in thread
From: Randy Dunlap @ 2025-10-16  3:59 UTC (permalink / raw)
  To: dri-devel
  Cc: Randy Dunlap, Alexander Usyskin, Lucas De Marchi, Jani Nikula,
	Rodrigo Vivi, Thomas Hellström, Joonas Lahtinen,
	Tvrtko Ursulin, intel-gfx, intel-xe, David Airlie, Simona Vetter

Use correct kernel-doc notation to prevent 3 kernel-doc warnings.
@push_payload is a struct member here, not a function, so use '@'
and ':' in its description.

Warning: intel_lb_mei_interface.h:55 Incorrect use of kernel-doc format:          * push_payload - Sends a payload to the authentication firmware
Warning: intel_lb_mei_interface.h:67 Invalid param: * @dev: Device struct corresponding to the mei device * @type: Payload type (see &enum intel_lb_type) * @flags: Payload flags bitmap (e.g. %INTEL_LB_FLAGS_IS_PERSISTENT) * @payload: Pointer to payload buffer * @payload_size: Payload buffer size in bytes * * Return: 0 success, negative errno value on transport failure, *         positive status returned by firmware */ int (*push_payload)(struct device *dev, u32 type, u32 flags, const void *payload, size_t payload_size)
Warning: intel_lb_mei_interface.h:67 struct member '* @dev: Device struct corresponding to the mei device * @type: Payload type (see &enum intel_lb_type' not described in 'intel_lb_component_ops'

Fixes: 741eeabb7c78 ("mei: late_bind: add late binding component driver")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Alexander Usyskin <alexander.usyskin@intel.com>
Cc: Lucas De Marchi <lucas.demarchi@intel.com>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Rodrigo Vivi <rodrigo.vivi@intel.com>
Cc: Thomas Hellström <thomas.hellstrom@linux.intel.com>
Cc: Joonas Lahtinen <joonas.lahtinen@linux.intel.com>
Cc: Tvrtko Ursulin <tursulin@ursulin.net>
Cc: intel-gfx@lists.freedesktop.org
Cc: intel-xe@lists.freedesktop.org
Cc: David Airlie <airlied@gmail.com>
Cc: Simona Vetter <simona@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
---
 include/drm/intel/intel_lb_mei_interface.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20251013.orig/include/drm/intel/intel_lb_mei_interface.h
+++ linux-next-20251013/include/drm/intel/intel_lb_mei_interface.h
@@ -53,7 +53,7 @@ enum intel_lb_status {
  */
 struct intel_lb_component_ops {
 	/**
-	 * push_payload - Sends a payload to the authentication firmware
+	 * @push_payload: Sends a payload to the authentication firmware
 	 * @dev: Device struct corresponding to the mei device
 	 * @type: Payload type (see &enum intel_lb_type)
 	 * @flags: Payload flags bitmap (e.g. %INTEL_LB_FLAGS_IS_PERSISTENT)

^ permalink raw reply	[flat|nested] 8+ messages in thread
end of thread, other threads:[~2025-10-17  0:22 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-16  3:59 [PATCH] mei: intel_lb_mei_interface.h: mark struct member with kernel-doc Randy Dunlap
2025-10-16  6:01 ` ✗ CI.checkpatch: warning for " Patchwork
2025-10-16  6:02 ` ✓ CI.KUnit: success " Patchwork
2025-10-16  6:44 ` ✓ Xe.CI.BAT: " Patchwork
2025-10-16  8:21 ` [PATCH] " Petr Vorel
2025-10-16 10:08 ` Gote, Nitin R
2025-10-16 19:03   ` Randy Dunlap
2025-10-17  0:22 ` ✓ Xe.CI.Full: success for " Patchwork

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox