2023-10-11 07:43:41

by Winkler, Tomas

Subject: [char-misc-next 1/3] mei: docs: use correct structures name in kdoc

Fix misalignment between structures names and their kdoc in hw.h

Signed-off-by: Tomas Winkler <[email protected]>
---
drivers/misc/mei/hw.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/misc/mei/hw.h b/drivers/misc/mei/hw.h
index e910302fcd1f6a28c13fa46c..3ad3080519c42521d8643396 100644
--- a/drivers/misc/mei/hw.h
+++ b/drivers/misc/mei/hw.h
@@ -429,7 +429,7 @@ struct mei_bus_message {
} __packed;

/**
- * struct hbm_cl_cmd - client specific host bus command
+ * struct mei_hbm_cl_cmd - client specific host bus command
* CONNECT, DISCONNECT, and FlOW CONTROL
*
* @hbm_cmd: bus message command header
@@ -733,7 +733,7 @@ struct hbm_dma_setup_response {
} __packed;

/**
- * struct mei_dma_ring_ctrl - dma ring control block
+ * struct hbm_dma_ring_ctrl - dma ring control block
*
* @hbuf_wr_idx: host circular buffer write index in slots
* @reserved1: reserved for alignment
--
2.41.0

2023-10-11 19:21:39

by Randy Dunlap

Subject: Re: [char-misc-next 1/3] mei: docs: use correct structures name in kdoc

On 10/11/23 00:42, Tomas Winkler wrote:
> Fix misalignment between structures names and their kdoc in hw.h
>
> Signed-off-by: Tomas Winkler <[email protected]>

Reviewed-by: Randy Dunlap <[email protected]>

Thanks.

> ---
> drivers/misc/mei/hw.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/misc/mei/hw.h b/drivers/misc/mei/hw.h
> index e910302fcd1f6a28c13fa46c..3ad3080519c42521d8643396 100644
> --- a/drivers/misc/mei/hw.h
> +++ b/drivers/misc/mei/hw.h
> @@ -429,7 +429,7 @@ struct mei_bus_message {
> } __packed;
>
> /**
> - * struct hbm_cl_cmd - client specific host bus command
> + * struct mei_hbm_cl_cmd - client specific host bus command
> * CONNECT, DISCONNECT, and FlOW CONTROL
> *
> * @hbm_cmd: bus message command header
> @@ -733,7 +733,7 @@ struct hbm_dma_setup_response {
> } __packed;
>
> /**
> - * struct mei_dma_ring_ctrl - dma ring control block
> + * struct hbm_dma_ring_ctrl - dma ring control block
> *
> * @hbuf_wr_idx: host circular buffer write index in slots
> * @reserved1: reserved for alignment

--
~Randy