Re: [RFC] Documentation dir is a mess

From: Marc Koschewski (marc_at_osknowledge.org)
Date: 11/21/05

  • Next message: Pavel Machek: "Re: [PATCH] make miniconfig (take 2)" 
    Date:	Mon, 21 Nov 2005 18:34:05 +0100
To: Steven Rostedt <rostedt@goodmis.org>

    * Steven Rostedt <rostedt@goodmis.org> [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@vger.kernel.org
    More majordomo info at http://vger.kernel.org/majordomo-info.html
    Please read the FAQ at http://www.tux.org/lkml/

  • Next message: Pavel Machek: "Re: [PATCH] make miniconfig (take 2)"

    Relevant Pages

    • Re: [RFC] Documentation dir is a mess
      ... about the whole source tree. ... (This isn't documentation about the proc ... send the line "unsubscribe linux-kernel" in ... More majordomo info at http://vger.kernel.org/majordomo-info.html ...
      (Linux-Kernel)
    • [RFC PATCH] was Re: [RFC] Documentation dir is a mess
      ... Just basing it on the source tree will not get you ... move all drivers_info into 'drivers' ... move all info/text files from source code to 'Documentation' dir ... send the line "unsubscribe linux-kernel" in ...
      (Linux-Kernel)
    • Re: [RFC] Documentation dir is a mess
      ... Just basing it on the source tree will not get you ... send the line "unsubscribe linux-kernel" in ... Please read the FAQ at http://www.tux.org/lkml/ ...
      (Linux-Kernel)
    • Re: [PATCH - EXPERIMENTAL] files with forks in the VFS
      ... an icon for a desktop app, documentation ... >In the first case, the subordinate files should clearly be writable, ... directory compression plugin for directories with lots of small files.... ... send the line "unsubscribe linux-kernel" in ...
      (Linux-Kernel)
    • Re: fcntl: F_SETLEASE/F_RDLCK question
      ... one of the original implementers seems to agree, ... I wrote the text in the fcntl() man page ... existing documentation of F_SETLEASE. ... send the line "unsubscribe linux-kernel" in ...
      (Linux-Kernel)