linux-kernel - Re: kernel-doc: fix doc blocks and html

lists.openwall.net		lists / announce john-users owl-users popa3d-users / xvendor oss-security / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4
Open Source and information security mailing list archives

Order Openwall GNU/*/Linux 2.0 on a CD with delivery worldwide

[<prev] [next>] [<thread-prev] [thread-next>] [month] [year] [list]

Date:	Fri, 31 Aug 2007 21:06:43 -0700
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	lkml <linux-kernel@...r.kernel.org>
Subject: Re: kernel-doc: fix doc blocks and html

On Fri, 31 Aug 2007 20:58:45 -0700 Randy Dunlap wrote:

> From: Randy Dunlap <randy.dunlap@...cle.com>
> 
> Cc: johannes@...solutions.net
> 
> Johannes Berg reports (Thanks!) that &struct names are not highlighted in
> html output format when they are inside a DOC: block.
> 
> DOC: blocks were not escaped thru xml_escape() like other kernel-doc
> comments were.  Fixed that.

Johannes is using a feature of kernel-doc that I wasn't even familiar
with, also one that no one else is using.  I'm sure that Johannes can
point us to some source code and generated output for it though.

If you want to see a little of it in source code form, 2 net drivers
use it, but then they aren't processed by kernel-doc for generated
output.  They are drivers/net/3c501.c & 3c527.c.  Look for the
"DOC:" comment blocks.

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/