diff mbox series

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

Message ID 20231011074301.223879-2-tomas.winkler@intel.com
State New
Headers
Series mei: documentation fixes |

Commit Message

Tomas Winkler Oct. 11, 2023, 7:42 a.m. UTC 
  Fix misalignment between structures names and their kdoc in hw.h

Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
---
 drivers/misc/mei/hw.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Randy Dunlap Oct. 11, 2023, 7:21 p.m. UTC | #1 
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 <tomas.winkler@intel.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

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
diff mbox series

Patch

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