Messages in this thread | | | Date | Tue, 29 Jan 2002 23:14:03 -0500 | From | Jeff Garzik <> | Subject | Re: A modest proposal -- We need a patch penguin |
| |
On Tue, Jan 29, 2002 at 06:54:04PM -0800, Linus Torvalds wrote: > Basically, I'd really like documentation to go with the thing it > documents. This is something where the docbook stuff helped noticeably.
Well... kinda sorta.
We -used- to really have documentation with the thing it documents, like drivers/foo/README. In-lined source comments are one piece of the puzzle yes, but the -bulk- of the docs are not anywhere near the thing it documents.
I actually don't like stuffing documents in Documentation/DocBook proper... I've put docs for two drivers in there, but if the trend continues a new dir structure will need to evolve.
Either we'll want Documentation/DocBook/<category>, or move the docbook docs into the standard Documentation/* hierarchy......... or we'll start moving docs back outside Documentation/*
Jeff, on a semi-tangent
- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |