lkml.org 
[lkml]   [2009]   [Feb]   [25]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    SubjectRe: Documentation:Update the INDEX of the documents
    From
    On Wed, Feb 25, 2009 at 10:59 PM, Theodore Tso <tytso@mit.edu> wrote:
    > On Wed, Feb 25, 2009 at 03:16:59PM +0800, Yang Hongyang wrote:
    >> There are so many 00-INDEX file that are missing description of the
    >> current files in the dir.  Such as 00-INDEX in
    >> Documentation/x86/,Documentation/networking/,Documentation/ and so
    >> on.
    >>
    >> It's a large amount of work for someone to go through all these
    >> documents and make summaries.
    >>
    >> I'm willing to do some of the work but if someone else pick these
    >> up(especially the authors of these new files) it will be a great
    >> help.^_^
    >
    > Before you embark on this large amount of work, we should probably ask
    > a question first --- how useful are the 00-INDEX files?  I don't find
    > them particularly interesting, given that my normal way of finding
    > documentation in the Documentation directory is:
    >
    > find . -type f | xargs grep <keyword>
    >
    > Or, if I have a git tree of the Linux sources handy:
    >
    > git grep <keyword> -- Documentation
    >
    > If folks do find the 00-INDEX files useful, my suggestion would be to
    > make a way of automatically extracting them from the individual files
    > and/or directories, and then making the 00-INDEX files to be
    > automatically generated.

    Sounds a good idea to me.If nobody interested in the 00-INDEX files,
    just remove it.

    >
    >                                                - Ted
    > --
    > 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/
    >
    --
    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/

    \
     
     \ /
      Last update: 2009-02-25 16:09    [W:0.027 / U:31.976 seconds]
    ©2003-2016 Jasper Spaans. hosted at Digital OceanAdvertise on this site