Re: [RFC] Documentation dir is a mess

From: Marc Koschewski
Date: Mon Nov 21 2005 - 12:33:31 EST


* Steven Rostedt <rostedt@xxxxxxxxxxx> [2005-11-20 20:56:59 -0500]:

> On Sun, 2005-11-20 at 16:30 -0800, Greg KH wrote:
> > On Sun, Nov 20, 2005 at 01:19:09PM +0100, Xose Vazquez Perez wrote:
> > > hi,
> > >
> > > _today_ Documentation/* is a mess of files. It would be good
> > > to have the _same_ tree as the code has:
> >
> > Do you have a proposal as to what specific files in that directory
> > should go where? Just basing it on the source tree will not get you
> > very far...
>
> Actually I think it's a good start. When I'm looking for documentation,
> I usually just do a grep -r on the Documentation directory hoping I get
> a correct hit and then manually look through all the results I get. It
> does get tedious, and I miss things all the time.

As you're just about to maybe make a decision on reorganisation: how about
a separation of user- and developer-relevant documentation? I mean, kernel
boot parameters are relevant to a user whereas mm/* stuff is not.

Marc
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/