Skip to content

Commit c192e54

Browse files
committed
cxl: Fix kernel-doc warnings
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] Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Reviewed-by: Dave Jiang <dave.jiang@intel.com> Link: https://lore.kernel.org/r/168679259170.3436160.3686460404739136336.stgit@dwillia2-xfh.jf.intel.com Signed-off-by: Dan Williams <dan.j.williams@intel.com>
1 parent 4c77cfc commit c192e54

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

drivers/cxl/cxlmem.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ static inline int cxl_mbox_cmd_rc2errno(struct cxl_mbox_cmd *mbox_cmd)
195195
*/
196196
#define CXL_CAPACITY_MULTIPLIER SZ_256M
197197

198-
/**
198+
/*
199199
* Event Interrupt Policy
200200
*
201201
* CXL rev 3.0 section 8.2.9.2.4; Table 8-52
@@ -215,8 +215,8 @@ struct cxl_event_interrupt_policy {
215215
/**
216216
* struct cxl_event_state - Event log driver state
217217
*
218-
* @event_buf: Buffer to receive event data
219-
* @event_log_lock: Serialize event_buf and log use
218+
* @buf: Buffer to receive event data
219+
* @log_lock: Serialize event_buf and log use
220220
*/
221221
struct cxl_event_state {
222222
struct cxl_get_event_payload *buf;

0 commit comments

Comments
 (0)