> Subject: [PATCH v2] mei: intel_lb_mei_interface.h: mark struct member with
> kernel-doc
> 
> 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'
> 

Not sure about the right format here but this patch makes things better.

Acked-by: Alexander Usyskin <[email protected]>

> Fixes: 741eeabb7c78 ("mei: late_bind: add late binding component driver")
> Signed-off-by: Randy Dunlap <[email protected]>
> Reviewed-by: Petr Vorel <[email protected]>
> Reviewed-by: Nitin Gote <[email protected]>
> ---
> v2: reformat long kernel-doc warning lines to <= 75 chars. (Nitin)
> 
> Cc: Alexander Usyskin <[email protected]>
> Cc: Lucas De Marchi <[email protected]>
> Cc: Jani Nikula <[email protected]>
> Cc: Rodrigo Vivi <[email protected]>
> Cc: Thomas Hellström <[email protected]>
> Cc: Joonas Lahtinen <[email protected]>
> Cc: Tvrtko Ursulin <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: David Airlie <[email protected]>
> Cc: Simona Vetter <[email protected]>
> Cc: [email protected]
> ---
>  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)

Reply via email to