From mboxrd@z Thu Jan 1 00:00:00 1970 From: Randy Dunlap Subject: Re: Documentation:Update the INDEX of the documents Date: Wed, 25 Feb 2009 16:52:26 -0800 Message-ID: <49A5E7CA.8020905@oracle.com> References: <49A4F06B.6030205@cn.fujitsu.com> <20090225145950.GJ7064@mit.edu> <20090225155628.GM7064@mit.edu> <49A5E72C.1080804@cn.fujitsu.com> Mime-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Cc: 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 To: Yang Hongyang Return-path: In-Reply-To: <49A5E72C.1080804@cn.fujitsu.com> Sender: linux-doc-owner@vger.kernel.org List-Id: netdev.vger.kernel.org Yang Hongyang wrote: > Theodore Tso wrote: >> On Wed, Feb 25, 2009 at 11:25:08PM +0800, Yang Hongyang wrote: >>>> 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? >> Well, for text files (including subdirectory's 00-INDEX files) we >> could have a convention which is the first line of the file should be >> a (max 60 characters) one-line summary of the file. >> >> We would probably have to do something special with non-free-form-text >> files, including structured text files like Docbook files. So it's >> not quite so straightforward, but it should be doable. > > Yeah,if we do this one-line summary thing,we still have to go through > all these documents.So why not just update the 00-INDEX and then tell > the authors that will add docs to the kernel do the "00-INDEX work" > themselves? I doubt that the 00-INDEX files are that useful... -- ~Randy