linux-kernel - Re: [PATCH 0/6] kernel-doc: add DOC: sections support

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

Message-ID: <20071026144609.GX19691@waste.org>
Date:	Fri, 26 Oct 2007 09:46:09 -0500
From:	Matt Mackall <mpm@...enic.com>
To:	Johannes Berg <johannes@...solutions.net>
Cc:	Randy Dunlap <rdunlap@...otime.net>, linux-kernel@...r.kernel.org,
	akpm@...ux-foundation.org, sam@...nborg.org
Subject: Re: [PATCH 0/6] kernel-doc: add DOC: sections support

On Fri, Oct 26, 2007 at 12:48:17PM +0200, Johannes Berg wrote:
> 
> > > ./drivers/net/3c527.c: * DOC: Notes
> > 
> > Aside from those being about the least interesting drivers in the
> > tree, that's pretty neat.
> > 
> > The docbook infrastructure probably needs to figure out a way to pick
> > up this stuff automatically if it's not otherwise tied in.
> 
> The 5th and 6th patch in this series do that by allowing you to write
> 
> !Pfilename section title
> 
> in a docbook template file to insert the contents of such a section.
> It's what I'm doing for mac80211's docs so that browsing the files gives
> you the same documentation as reading the mac80211 docbook book just
> organised differently.

There are lots and lots of files that currently contain kerneldoc
comments that are unreferenced by docbook (and have been for years).
We should somehow sweep them all up into some sort of bucket
automatically.

-- 
Mathematics is the supreme nostalgia of our time.
-
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/