Skip to contentSkip to conversation

cxl: Fix one kernel-doc comment

PATCH In review Yang Li 2 participants 2 messages Jun 29, 2023 CXL

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 cxl: Fix one kernel-doc comment

Make the description of @cxlds to @mds.
silence the warnings:
drivers/cxl/core/memdev.c:678: warning: Function parameter or member 'mds' not described in 'cxl_mem_get_fw_info' drivers/cxl/core/memdev.c:678: warning: Excess function parameter 'cxlds' description in 'cxl_mem_get_fw_info'

---
 drivers/cxl/core/memdev.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/cxl/core/memdev.c +1 -1
index 90237b9487a7..f99e7ec3cc40 100644
@@ -666,7 +666,7 @@ static int cxl_memdev_release_file(struct inode *inode, struct file *file)
 
 /**
  * cxl_mem_get_fw_info - Get Firmware info
- * @cxlds: The device data for the operation
+ * @mds: The device data for the operation
  *
  * Retrieve firmware info for the device specified.
  *
Signature · 1 line
2.20.1.7.g153144c
#1 lore raw
Quoted 6 lines · Yang Li

Make the description of @cxlds to @mds.
silence the warnings:
drivers/cxl/core/memdev.c:678: warning: Function parameter or member 'mds' not described in 'cxl_mem_get_fw_info' drivers/cxl/core/memdev.c:678: warning: Excess function parameter 'cxlds' description in 'cxl_mem_get_fw_info'

I fixed up the changelog to note that this was a missed fixup when merging for-6.5/cxl-fwupd with for-6.5/cxl-type-2, but otherwise looks good.