diff mbox series

PNP: system.c: unmark a comment as being kernel-doc

Message ID 20211002044500.24306-1-rdunlap@infradead.org (mailing list archive)
State Mainlined, archived
Headers show
Series PNP: system.c: unmark a comment as being kernel-doc | expand

Commit Message

Randy Dunlap Oct. 2, 2021, 4:45 a.m. UTC
Fix a documentation build warning caused by the comment not being
in kernel-doc format:

system.c:110: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Reserve motherboard resources after PCI claim BARs,

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: "Rafael J. Wysocki" <rafael.j.wysocki@intel.com>
Cc: linux-acpi@vger.kernel.org
---
 drivers/pnp/system.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Rafael J. Wysocki Oct. 5, 2021, 1:57 p.m. UTC | #1
On Sat, Oct 2, 2021 at 6:45 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Fix a documentation build warning caused by the comment not being
> in kernel-doc format:
>
> system.c:110: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Reserve motherboard resources after PCI claim BARs,
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Cc: Aditya Srivastava <yashsri421@gmail.com>
> Cc: "Rafael J. Wysocki" <rafael.j.wysocki@intel.com>
> Cc: linux-acpi@vger.kernel.org
> ---
>  drivers/pnp/system.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- linux-next-20211001.orig/drivers/pnp/system.c
> +++ linux-next-20211001/drivers/pnp/system.c
> @@ -106,7 +106,7 @@ static int __init pnp_system_init(void)
>         return pnp_register_driver(&system_pnp_driver);
>  }
>
> -/**
> +/*
>   * Reserve motherboard resources after PCI claim BARs,
>   * but before PCI assign resources for uninitialized PCI devices
>   */

Applied as 5.16 material, thanks!
diff mbox series

Patch

--- linux-next-20211001.orig/drivers/pnp/system.c
+++ linux-next-20211001/drivers/pnp/system.c
@@ -106,7 +106,7 @@  static int __init pnp_system_init(void)
 	return pnp_register_driver(&system_pnp_driver);
 }
 
-/**
+/*
  * Reserve motherboard resources after PCI claim BARs,
  * but before PCI assign resources for uninitialized PCI devices
  */