| Message ID | 20210522115227.9977-1-yashsri421@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | USB: gadget: udc: fix kernel-doc syntax in file headers | expand |
On 5/22/21 4:52 AM, Aditya Srivastava wrote: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for drivers/usb/gadget/udc/trace files follows this syntax, but > the content inside does not comply with kernel-doc. > > This line was probably not meant for kernel-doc parsing, but is parsed > due to the presence of kernel-doc like comment syntax(i.e, '/**'), which > causes unexpected warning from kernel-doc. > For e.g., running scripts/kernel-doc -none drivers/usb/gadget/udc/trace.h > emits: > warning: expecting prototype for udc.c(). Prototype was for TRACE_SYSTEM() instead > > Provide a simple fix by replacing this occurrence with general comment > format, i.e. '/*', to prevent kernel-doc from parsing it. > > Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > drivers/usb/gadget/udc/trace.c | 2 +- > drivers/usb/gadget/udc/trace.h | 2 +- > 2 files changed, 2 insertions(+), 2 deletions(-) > > diff --git a/drivers/usb/gadget/udc/trace.c b/drivers/usb/gadget/udc/trace.c > index 7430624c0bd7..19e837de2a20 100644 > --- a/drivers/usb/gadget/udc/trace.c > +++ b/drivers/usb/gadget/udc/trace.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * trace.c - USB Gadget Framework Trace Support > * > * Copyright (C) 2016 Intel Corporation > diff --git a/drivers/usb/gadget/udc/trace.h b/drivers/usb/gadget/udc/trace.h > index 2d1f68b5ea76..98584f6b6c66 100644 > --- a/drivers/usb/gadget/udc/trace.h > +++ b/drivers/usb/gadget/udc/trace.h > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0 > -/** > +/* > * udc.c - Core UDC Framework > * > * Copyright (C) 2016 Intel Corporation >
Aditya Srivastava <yashsri421@gmail.com> writes: > The opening comment mark '/**' is used for highlighting the beginning of > kernel-doc comments. > The header for drivers/usb/gadget/udc/trace files follows this syntax, but > the content inside does not comply with kernel-doc. > > This line was probably not meant for kernel-doc parsing, but is parsed > due to the presence of kernel-doc like comment syntax(i.e, '/**'), which > causes unexpected warning from kernel-doc. > For e.g., running scripts/kernel-doc -none drivers/usb/gadget/udc/trace.h > emits: > warning: expecting prototype for udc.c(). Prototype was for TRACE_SYSTEM() instead > > Provide a simple fix by replacing this occurrence with general comment > format, i.e. '/*', to prevent kernel-doc from parsing it. > > Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> Acked-by: Felipe Balbi <balbi@kernel.org> -- balbi
diff --git a/drivers/usb/gadget/udc/trace.c b/drivers/usb/gadget/udc/trace.c index 7430624c0bd7..19e837de2a20 100644 --- a/drivers/usb/gadget/udc/trace.c +++ b/drivers/usb/gadget/udc/trace.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0 -/** +/* * trace.c - USB Gadget Framework Trace Support * * Copyright (C) 2016 Intel Corporation diff --git a/drivers/usb/gadget/udc/trace.h b/drivers/usb/gadget/udc/trace.h index 2d1f68b5ea76..98584f6b6c66 100644 --- a/drivers/usb/gadget/udc/trace.h +++ b/drivers/usb/gadget/udc/trace.h @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0 -/** +/* * udc.c - Core UDC Framework * * Copyright (C) 2016 Intel Corporation
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments. The header for drivers/usb/gadget/udc/trace files follows this syntax, but the content inside does not comply with kernel-doc. This line was probably not meant for kernel-doc parsing, but is parsed due to the presence of kernel-doc like comment syntax(i.e, '/**'), which causes unexpected warning from kernel-doc. For e.g., running scripts/kernel-doc -none drivers/usb/gadget/udc/trace.h emits: warning: expecting prototype for udc.c(). Prototype was for TRACE_SYSTEM() instead Provide a simple fix by replacing this occurrence with general comment format, i.e. '/*', to prevent kernel-doc from parsing it. Signed-off-by: Aditya Srivastava <yashsri421@gmail.com> --- drivers/usb/gadget/udc/trace.c | 2 +- drivers/usb/gadget/udc/trace.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)