scsi: ufs: core: Fix some kernel-doc comments
Subsystems (2)
PATCH 1/1 scsi: ufs: core: Fix some kernel-doc comments
Use colons to separate parameter names from their specific meanings. silencethe warnings:
drivers/ufs/core/ufs-mcq.c:499: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_sq_cleanup' drivers/ufs/core/ufs-mcq.c:499: warning: Function parameter or member 'task_tag' not described in 'ufshcd_mcq_sq_cleanup' drivers/ufs/core/ufs-mcq.c:560: warning: Function parameter or member 'utrd' not described in 'ufshcd_mcq_nullify_sqe' drivers/ufs/core/ufs-mcq.c:583: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_sqe_search' drivers/ufs/core/ufs-mcq.c:583: warning: Function parameter or member 'hwq' not described in 'ufshcd_mcq_sqe_search' drivers/ufs/core/ufs-mcq.c:583: warning: Function parameter or member 'task_tag' not described in 'ufshcd_mcq_sqe_search' drivers/ufs/core/ufs-mcq.c:630: warning: Function parameter or member 'cmd' not described in 'ufshcd_mcq_abort'
--- drivers/ufs/core/ufs-mcq.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
drivers/ufs/core/ufs-mcq.c +7 -7
@@ -490,8 +490,8 @@ static int ufshcd_mcq_sq_start(struct ufs_hba *hba, struct ufs_hw_queue *hwq)/** * ufshcd_mcq_sq_cleanup - Clean up submission queue resources * associated with the pending command. -* @hba - per adapter instance. -* @task_tag - The command's task tag. +* @hba: per adapter instance. +* @task_tag: The command's task tag. * * Returns 0 for success; error code otherwise. */
@@ -554,7 +554,7 @@ int ufshcd_mcq_sq_cleanup(struct ufs_hba *hba, int task_tag)* Write the sqe's Command Type to 0xF. The host controller will not * fetch any sqe with Command Type = 0xF. * -* @utrd - UTP Transfer Request Descriptor to be nullified. +* @utrd: UTP Transfer Request Descriptor to be nullified. */ static void ufshcd_mcq_nullify_sqe (struct utp_transfer_req_desc *utrd) {
@@ -571,9 +571,9 @@ static void ufshcd_mcq_nullify_sqe(struct utp_transfer_req_desc *utrd)* If the command is in the submission queue and not issued to the device yet, * nullify the sqe so the host controller will skip fetching the sqe. * -* @hba - per adapter instance. -* @hwq - Hardware Queue to be searched. -* @task_tag - The command's task tag. +* @hba: per adapter instance. +* @hwq: Hardware Queue to be searched. +* @task_tag: The command's task tag. * * Returns true if the SQE containing the command is present in the SQ * (not fetched by the controller); returns false if the SQE is not in the SQ.
@@ -622,7 +622,7 @@ static bool ufshcd_mcq_sqe_search(struct ufs_hba *hba,/** * ufshcd_mcq_abort - Abort the command in MCQ. -* @cmd - The command to be aborted. +* @cmd: The command to be aborted. * * Returns SUCCESS or FAILED error codes */
Signature · 1 line
2.20.1.7.g153144c
Quoted 11 lines · Yang Li
Use colons to separate parameter names from their specific meanings. silencethe warnings:
drivers/ufs/core/ufs-mcq.c:499: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_sq_cleanup'drivers/ufs/core/ufs-mcq.c:499: warning: Function parameter or member 'task_tag' not described in 'ufshcd_mcq_sq_cleanup'drivers/ufs/core/ufs-mcq.c:560: warning: Function parameter or member 'utrd' not described in 'ufshcd_mcq_nullify_sqe'drivers/ufs/core/ufs-mcq.c:583: warning: Function parameter or member 'hba' not described in 'ufshcd_mcq_sqe_search'drivers/ufs/core/ufs-mcq.c:583: warning: Function parameter or member 'hwq' not described in 'ufshcd_mcq_sqe_search'drivers/ufs/core/ufs-mcq.c:583: warning: Function parameter or member 'task_tag' not described in 'ufshcd_mcq_sqe_search'drivers/ufs/core/ufs-mcq.c:630: warning: Function parameter or member 'cmd' not described in 'ufshcd_mcq_abort'
Quoted 3 lines
Reported-by Abaci Robot <[email protected]>Signed-off-by Yang Li <[email protected]>
Thanks.
Quoted 50 lines
--- drivers/ufs/core/ufs-mcq.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)drivers/ufs/core/ufs-mcq.c +7
-7@@ -490,8 +490,8 @@ static int ufshcd_mcq_sq_start(struct ufs_hba *hba, struct ufs_hw_queue *hwq)/** * ufshcd_mcq_sq_cleanup - Clean up submission queue resources * associated with the pending command. -* @hba - per adapter instance. -* @task_tag - The command's task tag. +* @hba: per adapter instance. +* @task_tag: The command's task tag. * * Returns 0 for success; error code otherwise. */ @@ -554,7 +554,7 @@ int ufshcd_mcq_sq_cleanup(struct ufs_hba *hba, int task_tag)* Write the sqe's Command Type to 0xF. The host controller will not * fetch any sqe with Command Type = 0xF. * -* @utrd - UTP Transfer Request Descriptor to be nullified. +* @utrd: UTP Transfer Request Descriptor to be nullified. */ static void ufshcd_mcq_nullify_sqe (struct utp_transfer_req_desc *utrd) {@@ -571,9 +571,9 @@ static void ufshcd_mcq_nullify_sqe(struct utp_transfer_req_desc *utrd)* If the command is in the submission queue and not issued to the device yet, * nullify the sqe so the host controller will skip fetching the sqe. * -* @hba - per adapter instance. -* @hwq - Hardware Queue to be searched. -* @task_tag - The command's task tag. +* @hba: per adapter instance. +* @hwq: Hardware Queue to be searched. +* @task_tag: The command's task tag. * * Returns true if the SQE containing the command is present in the SQ * (not fetched by the controller); returns false if the SQE is not in the SQ. @@ -622,7 +622,7 @@ static bool ufshcd_mcq_sqe_search(struct ufs_hba *hba,/** * ufshcd_mcq_abort - Abort the command in MCQ. -* @cmd - The command to be aborted. +* @cmd: The command to be aborted. * * Returns SUCCESS or FAILED error codes */
Signature · 1 line
~Randy
Quoted 1 line · Yang Li
Use colons to separate parameter names from their specific meanings.
Martin K. Petersen
AppliedYang,
Quoted 2 lines
Use colons to separate parameter names from their specific meanings. silencethe warnings:
Applied to 6.6/scsi-staging, thanks!
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering