Re: [PATCH v2 03/12] cxl: Fix kernel-doc warnings

[Dave Jiang <dave.jiang@intel.com>]

On 6/14/23 18:29, Dan Williams wrote:
> After Jonathan noticed [1] that 'struct cxl_dev_state' had a kernel-doc
> entry without a corresponding struct attribute I ran the kernel-doc
> script to see what else might be broken. Fix these warnings:
> 
> drivers/cxl/cxlmem.h:199: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>   * Event Interrupt Policy
> drivers/cxl/cxlmem.h:224: warning: Function parameter or member 'buf' not described in 'cxl_event_state'
> drivers/cxl/cxlmem.h:224: warning: Function parameter or member 'log_lock' not described in 'cxl_event_state'
> 
> Note that scripts/kernel-doc only finds missing kernel-doc entries. It
> does not warn on too many kernel-doc entries, i.e. it did not catch the
> fact that @info refers to a not present member.
> 
> Link: http://lore.kernel.org/r/20230606121054.000069e1@Huawei.com [1]
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>

Reviewed-by: Dave Jiang <dave.jiang@intel.com>
> ---
>   drivers/cxl/cxlmem.h |    6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/cxl/cxlmem.h b/drivers/cxl/cxlmem.h
> index a2845a7a69d8..8e4ba5b52902 100644
> --- a/drivers/cxl/cxlmem.h
> +++ b/drivers/cxl/cxlmem.h
> @@ -195,7 +195,7 @@ static inline int cxl_mbox_cmd_rc2errno(struct cxl_mbox_cmd *mbox_cmd)
>    */
>   #define CXL_CAPACITY_MULTIPLIER SZ_256M
>   
> -/**
> +/*
>    * Event Interrupt Policy
>    *
>    * CXL rev 3.0 section 8.2.9.2.4; Table 8-52
> @@ -215,8 +215,8 @@ struct cxl_event_interrupt_policy {
>   /**
>    * struct cxl_event_state - Event log driver state
>    *
> - * @event_buf: Buffer to receive event data
> - * @event_log_lock: Serialize event_buf and log use
> + * @buf: Buffer to receive event data
> + * @log_lock: Serialize event_buf and log use
>    */
>   struct cxl_event_state {
>   	struct cxl_get_event_payload *buf;
>