* [PATCH] USB: gadget: udc: fix kernel-doc syntax in file headers
@ 2021-05-22 11:52 Aditya Srivastava
2021-05-22 15:09 ` Randy Dunlap
2021-06-03 14:33 ` Felipe Balbi
0 siblings, 2 replies; 3+ messages in thread
From: Aditya Srivastava @ 2021-05-22 11:52 UTC (permalink / raw)
To: balbi
Cc: yashsri421, lukas.bulwahn, rdunlap, gregkh, linux-kernel-mentees,
linux-doc, linux-usb, linux-kernel
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(-)
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
--
2.17.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] USB: gadget: udc: fix kernel-doc syntax in file headers
2021-05-22 11:52 [PATCH] USB: gadget: udc: fix kernel-doc syntax in file headers Aditya Srivastava
@ 2021-05-22 15:09 ` Randy Dunlap
2021-06-03 14:33 ` Felipe Balbi
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2021-05-22 15:09 UTC (permalink / raw)
To: Aditya Srivastava, balbi
Cc: lukas.bulwahn, gregkh, linux-kernel-mentees, linux-doc,
linux-usb, linux-kernel
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
>
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] USB: gadget: udc: fix kernel-doc syntax in file headers
2021-05-22 11:52 [PATCH] USB: gadget: udc: fix kernel-doc syntax in file headers Aditya Srivastava
2021-05-22 15:09 ` Randy Dunlap
@ 2021-06-03 14:33 ` Felipe Balbi
1 sibling, 0 replies; 3+ messages in thread
From: Felipe Balbi @ 2021-06-03 14:33 UTC (permalink / raw)
To: Aditya Srivastava
Cc: yashsri421, lukas.bulwahn, rdunlap, gregkh, linux-kernel-mentees,
linux-doc, linux-usb, linux-kernel
[-- Attachment #1: Type: text/plain, Size: 916 bytes --]
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
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 511 bytes --]
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-06-03 14:33 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-22 11:52 [PATCH] USB: gadget: udc: fix kernel-doc syntax in file headers Aditya Srivastava
2021-05-22 15:09 ` Randy Dunlap
2021-06-03 14:33 ` Felipe Balbi
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).