Re: [PATCH] Documentation cleanup, update 00-INDEX files inDocumentation/

From: Henrik Austad
Date: Sat Feb 01 2014 - 11:50:31 EST


On Fri, Jan 31, 2014 at 02:24:42PM -0800, Andrew Morton wrote:
> On Wed, 29 Jan 2014 22:24:11 -0600 Rob Landley <rob@xxxxxxxxxxx> wrote:
>
> > On 01/29/14 18:27, Henrik Austad wrote:
> > > Some of the 00-INDEX files are somewhat outdated and some folders does not
> > > contain 00-INDEX at all. Only outdated (with the notably exception of
> > > spi) indexes are touched here, the 169 folders without 00-INDEX has not
> > > been touched.
> > >
> > > This applies to Linus' tip (0e47c969).
> >
> > Looks like an improvement.
> >
> > Acked-by: Rob Landley <rob@xxxxxxxxxxx>
>
> Are these 00-INDEX files actually useful? I've never opened one of
> them in my life.

That depends. They serve as a very nice starting point when you start to
dig into a particular part of the kernel. Once you're up and running
however, you probably won't need the index-files all that much.

So, I'd say they serve a purpose, but not a major one. For that reason, I
didn't start adding index-files to those directories that don't have them.
So, should we start an epic bikeshedding-context and ask "should we scrap
all 00-INDEX files in Documentation?" ;)

Either way, outdated index-files are pretty stupid, which was my motivation
for at least keeping them current.

--
Henrik Austad

Attachment: signature.asc
Description: Digital signature