Randy Dunlap 94dc7ad550 kernel-doc: detect/prevent duplicate doc section names
I saw this problem recently.  With this kernel-doc:

 * Note: some important info
 *
 * Note: other important info

kernel-doc uses the "section name" (preceding the ':', like "Note") as a hash
key for storing the descriptive text ("blah important info").  It is (was)
possible to have duplicate (colliding) section names, without any kind of
warning or error.

kernel-doc happily used the latter descriptive text for all instances of
printing the <section-name> descriptive text and the former important info
was lost.

One way to "fix" this is to modify the kernel-doc comments, e.g.:

 * Note1: foo bar
 *
 * Note.2: blah zay

For now, kernel-doc will signal an error when it sees colliding section names
like this.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2008-04-28 08:58:48 -07:00
..
2005-04-16 15:20:36 -07:00
2008-04-26 21:07:26 +02:00
2008-02-09 10:43:58 +01:00
2005-04-16 15:20:36 -07:00
2007-12-17 19:28:17 -08:00
2005-04-16 15:20:36 -07:00
2006-07-03 23:30:54 +02:00
2008-02-11 17:43:54 +01:00
2008-04-25 20:18:48 +02:00
2008-04-25 20:18:48 +02:00
2008-04-25 20:18:48 +02:00
2008-01-28 23:14:35 +01:00
2006-01-10 00:10:13 +01:00
2005-04-16 15:20:36 -07:00
2005-04-16 15:20:36 -07:00