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

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]

Date:	Sat, 01 Sep 2007 11:14:02 +0200
From:	Johannes Berg <johannes@...solutions.net>
To:	Randy Dunlap <randy.dunlap@...cle.com>
Cc:	lkml <linux-kernel@...r.kernel.org>,
	akpm <akpm@...ux-foundation.org>
Subject: Re: kernel-doc: fix doc blocks and html

On Fri, 2007-08-31 at 21:06 -0700, Randy Dunlap wrote:

> 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.

It's not been merged yet:
http://johannes.sipsolutions.net/files/mac80211.h.txt
and just generated with your updated kernel-doc:
http://johannes.sipsolutions.net/files/mac80211.html

Example for the problem is in the "Hardware crypto acceleration"
section, but it's now obviously no longer visible.

> 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.

Yeah, that's something I too need to work on. I'm thinking of making a
new include statement for the DOC: sections too, e.g.
   !P<filename>,<sectionname>

The thing is that if I simply add the docs to a docbook instead of DOC:
sections nobody will read it and I surely will continually need to point
to that. This way, people who use it daily will probably read it in the
header file but we can still generate pretty output for other places.

Anyhow, thanks a lot for this patch, the changes seem to work perfectly.

johannes

Download attachment "signature.asc" of type "application/pgp-signature" (191 bytes)