linux-kernel - Re: [PATCH] kernel-doc: fix function name in usercopy.c

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: <200610091507.36988.eike-kernel@sf-tec.de>
Date:	Mon, 9 Oct 2006 15:07:36 +0200
From:	Rolf Eike Beer <eike-kernel@...tec.de>
To:	Randy Dunlap <rdunlap@...otime.net>
Cc:	Alexey Dobriyan <adobriyan@...il.com>,
	linux-kernel@...r.kernel.org, akpm@...l.org
Subject: Re: [PATCH] kernel-doc: fix function name in usercopy.c

Randy Dunlap wrote:
> On Mon, 9 Oct 2006 07:28:51 +0400 Alexey Dobriyan wrote:
> > On Sun, Oct 08, 2006 at 07:44:29PM -0700, Randy Dunlap wrote:
> > >  /**
> > > - * strlen_user: - Get the size of a string in user space.
> > > + * strnlen_user: - Get the size of a string in user space.
> >
> > It's better to not spend time fixing mismatches, but to teach kernel-doc
> > extract function name from function itself.
> >
> > 	/**
> > 	 * Get the size of a string in user space.
> > 	 * @foo: bar
> > 	 */
> > 	 size_t strnlen_user()
>
> OK, maybe a good idea.  I'll add that to the wish list.
> However, we have seen examples of:
>
> /**
>  * doc for foo
>  */
> int foo(int arg)
> {
> }
>
> then someone inserts a new function bar() between the kernel-doc
> and foo().  How would we catch that (automated)?
> other than by our review process?

Warn if the function signature of the documented function does not match the 
function and throw away the manpage then.

Eike

Content of type "application/pgp-signature" skipped