linux-kernel - Re: [PATCH] PNP: system.c: unmark a comment as being kernel-doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CAJZ5v0ggDQ7ZXKRgZXQy-EsdD8-Yu01e=A+OSXm9UkJs2P8wUA@mail.gmail.com>
Date:   Tue, 5 Oct 2021 15:57:30 +0200
From:   "Rafael J. Wysocki" <rafael@...nel.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        kernel test robot <lkp@...el.com>,
        Aditya Srivastava <yashsri421@...il.com>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        ACPI Devel Maling List <linux-acpi@...r.kernel.org>
Subject: Re: [PATCH] PNP: system.c: unmark a comment as being kernel-doc

On Sat, Oct 2, 2021 at 6:45 AM Randy Dunlap <rdunlap@...radead.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@...radead.org>
> Reported-by: kernel test robot <lkp@...el.com>
> Cc: Aditya Srivastava <yashsri421@...il.com>
> Cc: "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>
> Cc: linux-acpi@...r.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!