* [PATCH] Hvideo: fbdev: pm2fb: Fix a kernel-doc formatting issue
@ 2022-04-01 8:41 Haowen Bai
2022-04-01 20:59 ` Helge Deller
0 siblings, 1 reply; 2+ messages in thread
From: Haowen Bai @ 2022-04-01 8:41 UTC (permalink / raw)
To: Helge Deller; +Cc: Haowen Bai, linux-fbdev, dri-devel, linux-kernel
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>
---
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.
*/
--
2.7.4
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] Hvideo: fbdev: pm2fb: Fix a kernel-doc formatting issue
2022-04-01 8:41 [PATCH] Hvideo: fbdev: pm2fb: Fix a kernel-doc formatting issue Haowen Bai
@ 2022-04-01 20:59 ` Helge Deller
0 siblings, 0 replies; 2+ messages in thread
From: Helge Deller @ 2022-04-01 20:59 UTC (permalink / raw)
To: Haowen Bai; +Cc: linux-fbdev, dri-devel, linux-kernel
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.
> */
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2022-04-01 20:59 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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 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).