2023-06-29 02:36:56

by Yang Li

Subject: [PATCH -next] 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'

Signed-off-by: Yang Li <[email protected]>
---
drivers/cxl/core/memdev.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/cxl/core/memdev.c b/drivers/cxl/core/memdev.c
index 90237b9487a7..f99e7ec3cc40 100644
--- a/drivers/cxl/core/memdev.c
+++ b/drivers/cxl/core/memdev.c
@@ -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.
*
--
2.20.1.7.g153144c

2023-06-29 23:25:15

by Dan Williams

Subject: RE: [PATCH -next] cxl: Fix one kernel-doc comment

Yang Li wrote:
> 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'
>
> Signed-off-by: Yang Li <[email protected]>

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.