From: Helge Deller <deller@gmx.de>
To: Haowen Bai <baihaowen@meizu.com>
Cc: linux-fbdev@vger.kernel.org, dri-devel@lists.freedesktop.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Hvideo: fbdev: pm2fb: Fix a kernel-doc formatting issue
Date: Fri, 1 Apr 2022 22:59:06 +0200 [thread overview]
Message-ID: <b096c0a8-105b-c3aa-06b2-27477d0a1458@gmx.de> (raw)
In-Reply-To: <1648802518-10571-1-git-send-email-baihaowen@meizu.com>
On 4/1/22 10:41, Haowen Bai wrote:
> This function had kernel-doc that not used a hash to separate
> the function name from the one line description.
>
> The warning was found by running scripts/kernel-doc, which is
> caused by using 'make W=1'.
>
> drivers/video/fbdev/pm2fb.c:1507: warning: This comment starts with '/**',
> but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> * Device initialisation
> drivers/video/fbdev/pm2fb.c:1714: warning: This comment starts with '/**',
> but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> * Device removal.
>
>
> Signed-off-by: Haowen Bai <baihaowen@meizu.com>
applied.
Thanks!
Helge
> ---
> drivers/video/fbdev/pm2fb.c | 8 ++------
> 1 file changed, 2 insertions(+), 6 deletions(-)
>
> diff --git a/drivers/video/fbdev/pm2fb.c b/drivers/video/fbdev/pm2fb.c
> index c68725eebee3..d3be2c64f1c0 100644
> --- a/drivers/video/fbdev/pm2fb.c
> +++ b/drivers/video/fbdev/pm2fb.c
> @@ -1504,9 +1504,7 @@ static const struct fb_ops pm2fb_ops = {
>
>
> /**
> - * Device initialisation
> - *
> - * Initialise and allocate resource for PCI device.
> + * pm2fb_probe - Initialise and allocate resource for PCI device.
> *
> * @pdev: PCI device.
> * @id: PCI device ID.
> @@ -1711,9 +1709,7 @@ static int pm2fb_probe(struct pci_dev *pdev, const struct pci_device_id *id)
> }
>
> /**
> - * Device removal.
> - *
> - * Release all device resources.
> + * pm2fb_remove - Release all device resources.
> *
> * @pdev: PCI device to clean up.
> */
prev parent reply other threads:[~2022-04-01 20:59 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-01 8:41 [PATCH] Hvideo: fbdev: pm2fb: Fix a kernel-doc formatting issue Haowen Bai
2022-04-01 20:59 ` Helge Deller [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=b096c0a8-105b-c3aa-06b2-27477d0a1458@gmx.de \
--to=deller@gmx.de \
--cc=baihaowen@meizu.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-fbdev@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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).