Date: Sun, 8 Oct 2006 20:36:17 -0700
From: Randy Dunlap <rdunlap@xenotime.net>
To: Alexey Dobriyan <adobriyan@gmail.com>
Cc: linux-kernel@vger.kernel.org, akpm@osdl.org
Subject: Re: [PATCH] kernel-doc: fix function name in usercopy.c
Message-Id: <20061008203617.f3ca1270.rdunlap@xenotime.net>
In-Reply-To: <20061009032851.GA5344@martell.zuzino.mipt.ru>
References: <20061008194429.c98d7387.rdunlap@xenotime.net>
	<20061009032851.GA5344@martell.zuzino.mipt.ru>
Organization: YPO4
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 1029
Lines: 37

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?

---
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/