Re: [PATCH 0/5] Add some missing Documentation/*/00-INDEX files

[Rob Landley]

On Sunday 12 August 2007 12:34:30 pm Stefan Richter wrote:
> Jesper Juhl wrote:
> > On 12/08/07, Stefan Richter <stefanr@xxxxxxxxxxxxxxxxx> wrote:
> >> Isn't it with 00-INDEX just like with the "Last Updated:" footers in
> >> documentation texts?
> >
> > That is certainly a risk, yes. But it shouldn't be hard to write a
> > small script to check if the 00-INDEX files are up-to-date, that will
> > make it pretty simple to update them once in a while if people forget.
>
> Or use the first line of each text file to describe what the file is about.

The first line of "unicode.txt" is:
                 Last update: 2005-01-17, version 1.4

The first line of "keys.txt" (and keys-request-key.txt) is:
                         ============================

The first line of sx.txt is blank, although that's easy enough to work around.

Lots of first lines redundantly have the filename in them, others have 
trailing information like the first nonblank line of kref.txt:

> krefs allow you to add reference counters to your objects.  If you

This heuristic seems to need about as much cleanup as just fixing 00-INDEX.txt 
in all the directories.

> And BTW, if authors insist on "Last Updated:", make it a header rather
> than a footer.  Increases the chance that submitters remember to update it.

Why not just use the source control system to review the actual revision 
history of the file?

Rob
-- 
"One of my most productive days was throwing away 1000 lines of code."
  - Ken Thompson.
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/