linux-kernel - Kerneldoc comments in files not mentioned by *.tmpl

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>] [day] [month] [year] [list]

Message-ID: <20071228134036.GA482@basil.nowhere.org>
Date:	Fri, 28 Dec 2007 14:40:36 +0100
From:	Andi Kleen <andi@...stfloor.org>
To:	randy.dunlap@...cle.com, linux-kernel@...r.kernel.org,
	rob@...dley.com
Subject: Kerneldoc comments in files not mentioned by *.tmpl

I added kerneldoc comments to some files and was a little surprised that
they didn't appear in make mandocs output. It turns out only functions in files
mentioned in Documentation/DocBook/*.tmpl are extracted. Since that's a 
pretty unknown requirement (at least I didn't know it) I suppose a lot
of the kerneldoc annotations actually are never generated because of this.

Should that be changed and let the scripts hunt for kerneldoc in all
source files?

A potential problem is that already the kerneldocs contain a lot 
of fairly useless driver internal funcions (e.g. nobody does care
a lot about internal MPT interfaces). But that problem is already
there and it's better to have too many than not enough in mandocs. 

-Andi
--
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/