Hvideo: fbdev: pm2fb: Fix a kernel-doc formatting issue

[PATCH] Hvideo: fbdev: pm2fb: Fix a kernel-doc formatting issue

Posted by Haowen Bai 4 years, 2 months ago

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

Re: [PATCH] Hvideo: fbdev: pm2fb: Fix a kernel-doc formatting issue

Posted by Helge Deller 4 years, 2 months ago

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.
>   */