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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <46BF6AE2.9070105@s5r6.in-berlin.de>
Date:	Sun, 12 Aug 2007 22:17:38 +0200
From:	Stefan Richter <stefanr@...6.in-berlin.de>
To:	Rob Landley <rob@...dley.net>
CC:	Jesper Juhl <jesper.juhl@...il.com>, linux-doc@...r.kernel.org,
	Randy Dunlap <rdunlap@...otime.net>,
	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH 0/5] Add some missing Documentation/*/00-INDEX files

Rob Landley wrote:
> On Sunday 12 August 2007 12:34:30 pm Stefan Richter wrote:
>> Or use the first line of each text file to describe what the file is about.
...
> This heuristic seems to need about as much cleanup as just fixing 00-INDEX.txt 
> in all the directories.

I didn't think of heuristics but rather of a style guideline.  Maybe
prepend this metadata line with "Subject: " or so to distinguish it from
data.

What's the difference to 00-INDEX?  It's inline.  Hence,
  - as soon as a majority of files have that header, authors of new
    files will start to provide that header automatically.  Or am I too
    optimistic?
  - it's a little bit faster to create these headers than to add them
    to 00-INDEX:  Just move the existing title to the top.

There could also be "From: " and/or "Cc: " headers for authorship and
maintainership metadata.  (Of course maintainership metadata could also
go into extra files like 00-INDEX or MAINTAINERS.  Authorship metadata
of more recent documentation files is actually available in the source
control system.)

>> 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?

Just to clarify:  I'm *not* one of those who want the date in there.
-- 
Stefan Richter
-=====-=-=== =--- -==--
http://arcgraph.de/sr/
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/