linux-kernel - Re: [PATCH] mtd: rawnand: vf610_nfc: use regular comments for functions

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] [thread-next>] [day] [month] [year] [list]

Date:   Fri, 13 Jan 2023 17:36:47 +0100
From:   Miquel Raynal <miquel.raynal@...tlin.com>
To:     Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc:     Miquel Raynal <miquel.raynal@...tlin.com>,
        Stefan Agner <stefan@...er.ch>,
        Richard Weinberger <richard@....at>,
        Vignesh Raghavendra <vigneshr@...com>,
        linux-mtd@...ts.infradead.org
Subject: Re: [PATCH] mtd: rawnand: vf610_nfc: use regular comments for functions

On Fri, 2023-01-13 at 06:40:04 UTC, Randy Dunlap wrote:
> These comments are not quite in kernel-doc format and they don't need
> to be, so just use "/*" comment markers for them. This prevents these
> kernel-doc warnings:
> 
> drivers/mtd/nand/raw/vf610_nfc.c:210: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Read accessor for internal SRAM buffer
> drivers/mtd/nand/raw/vf610_nfc.c:245: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Write accessor for internal SRAM buffer
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Stefan Agner <stefan@...er.ch>
> Cc: Miquel Raynal <miquel.raynal@...tlin.com>
> Cc: Richard Weinberger <richard@....at>
> Cc: Vignesh Raghavendra <vigneshr@...com>
> Cc: linux-mtd@...ts.infradead.org

Applied to https://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git nand/next, thanks.

Miquel