diff mbox series

phy: ti: report 2 non-kernel-doc comments

Message ID 20211115030559.13994-1-rdunlap@infradead.org
State Accepted
Commit 7adaf921b6438b6ba1c983a4ca5622f8173063f0
Headers show
Series phy: ti: report 2 non-kernel-doc comments | expand

Commit Message

Randy Dunlap Nov. 15, 2021, 3:05 a.m. UTC
Do not use "/**" to begin a non-kernel-doc comment.
Fixes these build warnings:

drivers/phy/ti/phy-am654-serdes.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * PCIe SERDES driver for AM654x SoC

drivers/phy/ti/phy-j721e-wiz.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Wrapper driver for SERDES used in J721E

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Kishon Vijay Abraham I <kishon@ti.com>
Cc: Vinod Koul <vkoul@kernel.org>
Cc: linux-phy@lists.infradead.org
---
 drivers/phy/ti/phy-am654-serdes.c |    2 +-
 drivers/phy/ti/phy-j721e-wiz.c    |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Vinod Koul Nov. 16, 2021, 10:40 a.m. UTC | #1
On 14-11-21, 19:05, Randy Dunlap wrote:
> Do not use "/**" to begin a non-kernel-doc comment.
> Fixes these build warnings:
> 
> drivers/phy/ti/phy-am654-serdes.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * PCIe SERDES driver for AM654x SoC
> 
> drivers/phy/ti/phy-j721e-wiz.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * Wrapper driver for SERDES used in J721E

Applied, thanks
diff mbox series

Patch

--- linux-next-20211102.orig/drivers/phy/ti/phy-am654-serdes.c
+++ linux-next-20211102/drivers/phy/ti/phy-am654-serdes.c
@@ -1,5 +1,5 @@ 
 // SPDX-License-Identifier: GPL-2.0
-/**
+/*
  * PCIe SERDES driver for AM654x SoC
  *
  * Copyright (C) 2018 - 2019 Texas Instruments Incorporated - http://www.ti.com/
--- linux-next-20211102.orig/drivers/phy/ti/phy-j721e-wiz.c
+++ linux-next-20211102/drivers/phy/ti/phy-j721e-wiz.c
@@ -1,5 +1,5 @@ 
 // SPDX-License-Identifier: GPL-2.0
-/**
+/*
  * Wrapper driver for SERDES used in J721E
  *
  * Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/