* [PATCH] scsi: ufs: Fix kernel-doc syntax
@ 2023-02-02 22:01 Bart Van Assche
2023-02-02 23:58 ` Asutosh Das
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Bart Van Assche @ 2023-02-02 22:01 UTC (permalink / raw)
To: Martin K . Petersen
Cc: Jaegeuk Kim, Avri Altman, Adrian Hunter, linux-scsi,
Bart Van Assche, Asutosh Das, James E.J. Bottomley, Can Guo,
Manivannan Sadhasivam
Fix the following kernel-doc warnings:
drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_config_mac'
drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'max_active_cmds' not described in 'ufshcd_mcq_config_mac'
drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_req_to_hwq'
drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'req' not described in 'ufshcd_mcq_req_to_hwq'
drivers/ufs/core/ufs-mcq.c:128: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_decide_queue_depth'
Cc: Asutosh Das <quic_asutoshd@quicinc.com>
Fixes: 854f84e7feeb ("scsi: ufs: core: mcq: Find hardware queue to queue request")
Fixes: 2468da61ea09 ("scsi: ufs: core: mcq: Configure operation and runtime interface")
Fixes: 7224c806876e ("scsi: ufs: core: mcq: Calculate queue depth")
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
drivers/ufs/core/ufs-mcq.c | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/drivers/ufs/core/ufs-mcq.c b/drivers/ufs/core/ufs-mcq.c
index dd476f9e797c..31df052fbc41 100644
--- a/drivers/ufs/core/ufs-mcq.c
+++ b/drivers/ufs/core/ufs-mcq.c
@@ -77,8 +77,8 @@ MODULE_PARM_DESC(poll_queues,
/**
* ufshcd_mcq_config_mac - Set the #Max Activ Cmds.
- * @hba - per adapter instance
- * @max_active_cmds - maximum # of active commands to the device at any time.
+ * @hba: per adapter instance
+ * @max_active_cmds: maximum # of active commands to the device at any time.
*
* The controller won't send more than the max_active_cmds to the device at
* any time.
@@ -96,8 +96,8 @@ void ufshcd_mcq_config_mac(struct ufs_hba *hba, u32 max_active_cmds)
/**
* ufshcd_mcq_req_to_hwq - find the hardware queue on which the
* request would be issued.
- * @hba - per adapter instance
- * @req - pointer to the request to be issued
+ * @hba: per adapter instance
+ * @req: pointer to the request to be issued
*
* Returns the hardware queue instance on which the request would
* be queued.
@@ -114,7 +114,7 @@ struct ufs_hw_queue *ufshcd_mcq_req_to_hwq(struct ufs_hba *hba,
/**
* ufshcd_mcq_decide_queue_depth - decide the queue depth
- * @hba - per adapter instance
+ * @hba: per adapter instance
*
* Returns queue-depth on success, non-zero on error
*
^ permalink raw reply related [flat|nested] 4+ messages in thread* Re: [PATCH] scsi: ufs: Fix kernel-doc syntax
2023-02-02 22:01 [PATCH] scsi: ufs: Fix kernel-doc syntax Bart Van Assche
@ 2023-02-02 23:58 ` Asutosh Das
2023-02-08 23:57 ` Martin K. Petersen
2023-02-14 16:57 ` Martin K. Petersen
2 siblings, 0 replies; 4+ messages in thread
From: Asutosh Das @ 2023-02-02 23:58 UTC (permalink / raw)
To: Bart Van Assche
Cc: Martin K . Petersen, Jaegeuk Kim, Avri Altman, Adrian Hunter,
linux-scsi, James E.J. Bottomley, Can Guo, Manivannan Sadhasivam
On Thu, Feb 02 2023 at 14:02 -0800, Bart Van Assche wrote:
>Fix the following kernel-doc warnings:
>
>drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_config_mac'
>drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'max_active_cmds' not described in 'ufshcd_mcq_config_mac'
>drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_req_to_hwq'
>drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'req' not described in 'ufshcd_mcq_req_to_hwq'
>drivers/ufs/core/ufs-mcq.c:128: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_decide_queue_depth'
>
>Cc: Asutosh Das <quic_asutoshd@quicinc.com>
>Fixes: 854f84e7feeb ("scsi: ufs: core: mcq: Find hardware queue to queue request")
>Fixes: 2468da61ea09 ("scsi: ufs: core: mcq: Configure operation and runtime interface")
>Fixes: 7224c806876e ("scsi: ufs: core: mcq: Calculate queue depth")
>Signed-off-by: Bart Van Assche <bvanassche@acm.org>
>---
> drivers/ufs/core/ufs-mcq.c | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
>
Thanks for the fix.
Reviewed-by: Asutosh Das <quic_asutoshd@quicinc.com>
>diff --git a/drivers/ufs/core/ufs-mcq.c b/drivers/ufs/core/ufs-mcq.c
>index dd476f9e797c..31df052fbc41 100644
>--- a/drivers/ufs/core/ufs-mcq.c
>+++ b/drivers/ufs/core/ufs-mcq.c
>@@ -77,8 +77,8 @@ MODULE_PARM_DESC(poll_queues,
>
> /**
> * ufshcd_mcq_config_mac - Set the #Max Activ Cmds.
>- * @hba - per adapter instance
>- * @max_active_cmds - maximum # of active commands to the device at any time.
>+ * @hba: per adapter instance
>+ * @max_active_cmds: maximum # of active commands to the device at any time.
> *
> * The controller won't send more than the max_active_cmds to the device at
> * any time.
>@@ -96,8 +96,8 @@ void ufshcd_mcq_config_mac(struct ufs_hba *hba, u32 max_active_cmds)
> /**
> * ufshcd_mcq_req_to_hwq - find the hardware queue on which the
> * request would be issued.
>- * @hba - per adapter instance
>- * @req - pointer to the request to be issued
>+ * @hba: per adapter instance
>+ * @req: pointer to the request to be issued
> *
> * Returns the hardware queue instance on which the request would
> * be queued.
>@@ -114,7 +114,7 @@ struct ufs_hw_queue *ufshcd_mcq_req_to_hwq(struct ufs_hba *hba,
>
> /**
> * ufshcd_mcq_decide_queue_depth - decide the queue depth
>- * @hba - per adapter instance
>+ * @hba: per adapter instance
> *
> * Returns queue-depth on success, non-zero on error
> *
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] scsi: ufs: Fix kernel-doc syntax
2023-02-02 22:01 [PATCH] scsi: ufs: Fix kernel-doc syntax Bart Van Assche
2023-02-02 23:58 ` Asutosh Das
@ 2023-02-08 23:57 ` Martin K. Petersen
2023-02-14 16:57 ` Martin K. Petersen
2 siblings, 0 replies; 4+ messages in thread
From: Martin K. Petersen @ 2023-02-08 23:57 UTC (permalink / raw)
To: Bart Van Assche
Cc: Martin K . Petersen, Jaegeuk Kim, Avri Altman, Adrian Hunter,
linux-scsi, Asutosh Das, James E.J. Bottomley, Can Guo,
Manivannan Sadhasivam
Bart,
> Fix the following kernel-doc warnings:
>
> drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_config_mac'
> drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'max_active_cmds' not described in 'ufshcd_mcq_config_mac'
> drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_req_to_hwq'
> drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'req' not described in 'ufshcd_mcq_req_to_hwq'
> drivers/ufs/core/ufs-mcq.c:128: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_decide_queue_depth'
Applied to 6.3/scsi-staging, thanks!
--
Martin K. Petersen Oracle Linux Engineering
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] scsi: ufs: Fix kernel-doc syntax
2023-02-02 22:01 [PATCH] scsi: ufs: Fix kernel-doc syntax Bart Van Assche
2023-02-02 23:58 ` Asutosh Das
2023-02-08 23:57 ` Martin K. Petersen
@ 2023-02-14 16:57 ` Martin K. Petersen
2 siblings, 0 replies; 4+ messages in thread
From: Martin K. Petersen @ 2023-02-14 16:57 UTC (permalink / raw)
To: Bart Van Assche
Cc: Martin K . Petersen, Jaegeuk Kim, Avri Altman, Adrian Hunter,
linux-scsi, Asutosh Das, James E.J. Bottomley, Can Guo,
Manivannan Sadhasivam
On Thu, 02 Feb 2023 14:01:42 -0800, Bart Van Assche wrote:
> Fix the following kernel-doc warnings:
>
> drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_config_mac'
> drivers/ufs/core/ufs-mcq.c:87: warning: Function parameter or member 'max_active_cmds' not described in 'ufshcd_mcq_config_mac'
> drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_req_to_hwq'
> drivers/ufs/core/ufs-mcq.c:107: warning: Function parameter or member 'req' not described in 'ufshcd_mcq_req_to_hwq'
> drivers/ufs/core/ufs-mcq.c:128: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_decide_queue_depth'
>
> [...]
Applied to 6.3/scsi-queue, thanks!
[1/1] scsi: ufs: Fix kernel-doc syntax
https://git.kernel.org/mkp/scsi/c/b62c8292d223
--
Martin K. Petersen Oracle Linux Engineering
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2023-02-14 16:58 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-02-02 22:01 [PATCH] scsi: ufs: Fix kernel-doc syntax Bart Van Assche
2023-02-02 23:58 ` Asutosh Das
2023-02-08 23:57 ` Martin K. Petersen
2023-02-14 16:57 ` Martin K. Petersen
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.