From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1763501AbZBYP2A (ORCPT ); Wed, 25 Feb 2009 10:28:00 -0500 Received: (majordomo@vger.kernel.org) by vger.kernel.org id S932402AbZBYPZR (ORCPT ); Wed, 25 Feb 2009 10:25:17 -0500 Received: from mail-gx0-f174.google.com ([209.85.217.174]:49374 "EHLO mail-gx0-f174.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1761994AbZBYPZN convert rfc822-to-8bit (ORCPT ); Wed, 25 Feb 2009 10:25:13 -0500 DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type:content-transfer-encoding; b=SFOmSazFU6nQnuLJ6HyQ3iFY6dsQ50BsbUVAA6634l0y2JXc4+T7tp95xrfmrk0DyD 46Xu7Oxw6lvwOSfRByEwsUJa9XWgWHD4XvBDQ3g+Ur3TVL2ZpoZ7IHsld+4cQdyIG7nK ZbC/37MQOgfeUaFx86MIQ58xPkmhmcHZbAfpk= MIME-Version: 1.0 In-Reply-To: <20090225145950.GJ7064@mit.edu> References: <49A4F06B.6030205@cn.fujitsu.com> <20090225145950.GJ7064@mit.edu> Date: Wed, 25 Feb 2009 23:25:08 +0800 Message-ID: Subject: Re: Documentation:Update the INDEX of the documents From: Yang Hongyang To: Theodore Tso , Yang Hongyang , netdev@vger.kernel.org, "David S. Miller" , linux-kernel@vger.kernel.org, Andrew Morton , linux-doc@vger.kernel.org, mtk.manpages@gmail.com, rdunlap@xenotime.net Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 8BIT Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Wed, Feb 25, 2009 at 10:59 PM, Theodore Tso 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: I think the 00-INDEX files is used to generate the html files. > > find . -type f | xargs grep > > Or, if I have a git tree of the Linux sources handy: > > git grep -- 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 like a good idea but How to automatically generate the summaries then? > >                                                - 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/ >