Skip to contentSkip to conversation

scsi: ufs: Fix a kernel-doc related formatting issue

PATCH Applied Bean Huo 4 participants 5 messages May 31, 2021 – Jun 8, 2021 SCSI

lore
Share & tools
lore

Bean Huo

author
#0 lore raw

PATCH 1/1 scsi: ufs: Fix a kernel-doc related formatting issue

From: Bean Huo <[email protected]>

Fix the following W=1 kernel build warning:

drivers/scsi/ufs/ufshcd.c:9773: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

---
 drivers/scsi/ufs/ufshcd.c | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)
drivers/scsi/ufs/ufshcd.c +1 -4
index 02267b090729..2cdd1f6da670 100644
@@ -9769,10 +9769,7 @@ static const struct dev_pm_ops ufs_rpmb_pm_ops = {
 	SET_SYSTEM_SLEEP_PM_OPS(NULL, ufshcd_rpmb_resume)
 };
 
-/**
- * Describes the ufs rpmb wlun.
- * Used only to send uac.
- */
+/* ufs_rpmb_wlun_template - Describes UFS rpmb wlun. Used only to send uac. */
 static struct scsi_driver ufs_rpmb_wlun_template = {
 	.gendrv = {
 		.name = "ufs_rpmb_wlun",
Signature · 1 line
2.25.1
#1 lore raw
Quoted 1 line · Bean Huo

+/* ufs_rpmb_wlun_template - Describes UFS rpmb wlun. Used only to send uac. */

Hi Bean,

For future patches, since RPMB, WLUN and UAC are all abbreviations, please capitalize these.

Thanks,

Bart.

Reviewed-by on v1 1/1
#2 lore raw
In reply to Bean Huo

Hi Bean,

Quoted 9 lines

-----Original Message-----
From: Bean Huo <[email protected]>
Sent: 31 May 2021 22:01
To: [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]
Cc: [email protected]; [email protected]
Subject: [PATCH] scsi: ufs: Fix a kernel-doc related formatting issue

Quoted 5 lines

From: Bean Huo <[email protected]>

Fix the following W=1 kernel build warning:

drivers/scsi/ufs/ufshcd.c:9773: warning: This comment starts with '/**',

but

Quoted 4 lines

isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

---

Quoted 2 lines
 drivers/scsi/ufs/ufshcd.c | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

.
.
.

Quoted 2 lines

--
2.25.1

#3 lore raw
In reply to Bean Huo

Bean,

Quoted 1 line

Fix the following W=1 kernel build warning:

Applied to 5.14/scsi-staging, thanks!

Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering
#4 lore raw
In reply to Bean Huo
Quoted 3 lines · Bean Huo

Fix the following W=1 kernel build warning:

drivers/scsi/ufs/ufshcd.c:9773: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Applied to 5.14/scsi-queue, thanks!

[1/1] scsi: ufs: Fix a kernel-doc related formatting issue

      https://git.kernel.org/mkp/scsi/c/f6b414294224
Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering