On 3/29/21 6:51 AM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > There are certain files in drivers/usb/dwc3, which follow this syntax, > but the content inside does not comply with kernel-doc. > Such lines were probably not meant for kernel-doc parsing, but are parsed > due to the presence of kernel-doc like comment syntax(i.e, '/**'), which > causes unexpected warnings from kernel-doc. > > E.g., presence of kernel-doc like comment in drivers/usb/dwc3/io.h at > header causes this warnings by kernel-doc: > "warning: expecting prototype for h(). Prototype was for __DRIVERS_USB_DWC3_IO_H() instead" > > Similarly for other files too. > > Provide a simple fix by replacing such occurrences with general comment > format, i.e. '/*', to prevent kernel-doc from parsing it. > > Signed-off-by: Aditya Srivastava <yashsri421@xxxxxxxxx> Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx> Thanks. > --- > * Applies perfectly on next-20210326 > > drivers/usb/dwc3/debug.h | 2 +- > drivers/usb/dwc3/debugfs.c | 2 +- > drivers/usb/dwc3/dwc3-keystone.c | 2 +- > drivers/usb/dwc3/dwc3-pci.c | 2 +- > drivers/usb/dwc3/io.h | 2 +- > drivers/usb/dwc3/trace.c | 2 +- > drivers/usb/dwc3/trace.h | 2 +- > 7 files changed, 7 insertions(+), 7 deletions(-) > > diff --git a/drivers/usb/dwc3/debug.h b/drivers/usb/dwc3/debug.h > index 8ab394942360..db231de46bb3 100644 > --- a/drivers/usb/dwc3/debug.h > +++ b/drivers/usb/dwc3/debug.h > @@ -1,5 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0 */ > -/** > +/* > * debug.h - DesignWare USB3 DRD Controller Debug Header > * > * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com > diff --git a/drivers/usb/dwc3/debugfs.c b/drivers/usb/dwc3/debugfs.c > index 5da4f6082d93..b0e3f434d219 100644 > --- a/drivers/usb/dwc3/debugfs.c > +++ b/drivers/usb/dwc3/debugfs.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * debugfs.c - DesignWare USB3 DRD Controller DebugFS file > * > * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com > diff --git a/drivers/usb/dwc3/dwc3-keystone.c b/drivers/usb/dwc3/dwc3-keystone.c > index 057056c0975e..1317959294e6 100644 > --- a/drivers/usb/dwc3/dwc3-keystone.c > +++ b/drivers/usb/dwc3/dwc3-keystone.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * dwc3-keystone.c - Keystone Specific Glue layer > * > * Copyright (C) 2010-2013 Texas Instruments Incorporated - https://www.ti.com > diff --git a/drivers/usb/dwc3/dwc3-pci.c b/drivers/usb/dwc3/dwc3-pci.c > index 4c5c6972124a..4698c43af5ae 100644 > --- a/drivers/usb/dwc3/dwc3-pci.c > +++ b/drivers/usb/dwc3/dwc3-pci.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * dwc3-pci.c - PCI Specific glue layer > * > * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com > diff --git a/drivers/usb/dwc3/io.h b/drivers/usb/dwc3/io.h > index 76b73b116862..1e96ea339d48 100644 > --- a/drivers/usb/dwc3/io.h > +++ b/drivers/usb/dwc3/io.h > @@ -1,5 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0 */ > -/** > +/* > * io.h - DesignWare USB3 DRD IO Header > * > * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com > diff --git a/drivers/usb/dwc3/trace.c b/drivers/usb/dwc3/trace.c > index 1b45a9723eeb..088995885678 100644 > --- a/drivers/usb/dwc3/trace.c > +++ b/drivers/usb/dwc3/trace.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * trace.c - DesignWare USB3 DRD Controller Trace Support > * > * Copyright (C) 2014 Texas Instruments Incorporated - https://www.ti.com > diff --git a/drivers/usb/dwc3/trace.h b/drivers/usb/dwc3/trace.h > index 97f4f1125a41..60883268adfc 100644 > --- a/drivers/usb/dwc3/trace.h > +++ b/drivers/usb/dwc3/trace.h > @@ -1,5 +1,5 @@ > /* SPDX-License-Identifier: GPL-2.0 */ > -/** > +/* > * trace.h - DesignWare USB3 DRD Controller Trace Support > * > * Copyright (C) 2014 Texas Instruments Incorporated - https://www.ti.com > -- ~Randy
