On Thu, Oct 25, 2007 at 10:36:11AM -0700, Randy Dunlap wrote:
> On Thu, 25 Oct 2007 12:29:32 -0500 Matt Mackall wrote:
>
> > On Wed, Oct 24, 2007 at 03:08:48PM -0700, Randy Dunlap wrote:
> > >
> > > This patch series from Johannes Berg adds support for DOC: sections
> > > that are embedded in source files.
> >
> > What do these look like?
>
> There are currently 2 files in the kernel tree that contain DOC:
> sections. These are not used in the docbooks, but you can see what
> they look like here:
>
> ./drivers/net/3c501.c: * DOC: 3c501 Card Notes
> ./drivers/net/3c501.c: * DOC: Problems
> ./drivers/net/3c527.c: * DOC: Traps for the unwary
> ./drivers/net/3c527.c: * DOC: Theory Of Operation
> ./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.
With Python, I can do pydoc foo.py or pydoc foo/ and immediately get
browsable extracted docs in $PAGER for the associated file or
directory. Would be nice to get a little closer to that here.
--
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 [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[Index of Archives]
[Kernel Newbies]
[Netfilter]
[Bugtraq]
[Photo]
[Stuff]
[Gimp]
[Yosemite News]
[MIPS Linux]
[ARM Linux]
[Linux Security]
[Linux RAID]
[Video 4 Linux]
[Linux for the blind]
[Linux Resources]
