From: Randy Dunlap <rdunlap@infradead.org>
To: Aditya Srivastava <yashsri421@gmail.com>, balbi@kernel.org
Cc: lukas.bulwahn@gmail.com, gregkh@linuxfoundation.org,
linux-kernel-mentees@lists.linuxfoundation.org,
linux-doc@vger.kernel.org, linux-usb@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] usb: dwc3: fix incorrect kernel-doc comment syntax in files
Date: Mon, 29 Mar 2021 11:18:19 -0700 [thread overview]
Message-ID: <15c0a26f-851b-862c-a3ca-52989d428c89@infradead.org> (raw)
In-Reply-To: <20210329135108.27128-1-yashsri421@gmail.com>
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@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
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
prev parent reply other threads:[~2021-03-29 18:19 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-29 13:51 [PATCH] usb: dwc3: fix incorrect kernel-doc comment syntax in files Aditya Srivastava
2021-03-29 18:18 ` Randy Dunlap [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=15c0a26f-851b-862c-a3ca-52989d428c89@infradead.org \
--to=rdunlap@infradead.org \
--cc=balbi@kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=yashsri421@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).