diff mbox series

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

Message ID 20210531163122.451375-1-huobean@gmail.com (mailing list archive)
State Accepted
Headers show
Series scsi: ufs: Fix a kernel-doc related formatting issue | expand

Commit Message

Bean Huo May 31, 2021, 4:31 p.m. UTC 
From: Bean Huo <beanhuo@micron.com>

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

Signed-off-by: Bean Huo <beanhuo@micron.com>
---
 drivers/scsi/ufs/ufshcd.c | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

Comments

Alim Akhtar May 31, 2021, 4:36 p.m. UTC | #1 
Hi Bean,

> -----Original Message-----
> From: Bean Huo <huobean@gmail.com>
> Sent: 31 May 2021 22:01
> To: alim.akhtar@samsung.com; avri.altman@wdc.com; jejb@linux.ibm.com;
> martin.petersen@oracle.com; beanhuo@micron.com;
> bvanassche@acm.org; tomas.winkler@intel.com; cang@codeaurora.org
> Cc: linux-scsi@vger.kernel.org; linux-kernel@vger.kernel.org
> Subject: [PATCH] scsi: ufs: Fix a kernel-doc related formatting issue
> 
> From: Bean Huo <beanhuo@micron.com>
> 
> 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
> 
> Signed-off-by: Bean Huo <beanhuo@micron.com>
> ---
Reviewed-by: Alim Akhtar <alim.akhtar@samsung.com>

>  drivers/scsi/ufs/ufshcd.c | 5 +----
>  1 file changed, 1 insertion(+), 4 deletions(-)
.
.
.
> --
> 2.25.1
Bart Van Assche May 31, 2021, 9:03 p.m. UTC | #2 
On 5/31/21 9:31 AM, Bean Huo wrote:
> +/* 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.
Martin K. Petersen June 2, 2021, 3:43 a.m. UTC | #3 
Bean,

> Fix the following W=1 kernel build warning:

Applied to 5.14/scsi-staging, thanks!
Martin K. Petersen June 8, 2021, 3:05 a.m. UTC | #4 
On Mon, 31 May 2021 18:31:22 +0200, Bean Huo wrote:

> 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
diff mbox series

Patch

diff --git a/drivers/scsi/ufs/ufshcd.c b/drivers/scsi/ufs/ufshcd.c
index 02267b090729..2cdd1f6da670 100644
--- a/drivers/scsi/ufs/ufshcd.c
+++ b/drivers/scsi/ufs/ufshcd.c
@@ -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",