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
| ||
|
Message-ID: <YzIUS/+H2YA7RBvA@casper.infradead.org> Date: Mon, 26 Sep 2022 22:06:19 +0100 From: Matthew Wilcox <willy@...radead.org> To: Kees Cook <keescook@...omium.org> Cc: Jonathan Corbet <corbet@....net>, Akira Yokosawa <akiyks@...il.com>, linux-doc@...r.kernel.org, linux-hardening@...r.kernel.org, linux-kernel@...r.kernel.org Subject: Re: [PATCH] overflow: Fix kern-doc markup for functions On Mon, Sep 26, 2022 at 12:47:13PM -0700, Kees Cook wrote: > -/** check_add_overflow() - Calculate addition with overflow checking > +/** > + * check_add_overflow - Calculate addition with overflow checking > * > * @a: first addend > * @b: second addend Why did you remove the ()? And why didn't you delete the blank line? According to our documentation, the canonical form is: /** * function_name() - Brief description of function. * @arg1: Describe the first argument. * @arg2: Describe the second argument. * One can provide multiple line descriptions * for arguments. I don't usually complain about people getting that wrong, but when people correct it to be wrong ...
Powered by blists - more mailing lists