linux-kernel - Re: [PATCH] [RFC v2] Drop all 00-INDEX files from Documentation/

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>] [day] [month] [year] [list]

Date:   Mon, 3 Sep 2018 19:45:35 -0700
From:   Josh Triplett <josh@...htriplett.org>
To:     Henrik Austad <henrik@...tad.us>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] [RFC v2] Drop all 00-INDEX files from Documentation/

[Trimming to author, linux-doc, and LKML for response.]

On Tue, Sep 04, 2018 at 12:15:23AM +0200, Henrik Austad wrote:
> The 00-INDEX files are supposed to give a summary of all files present
> in a directory, but these files are horribly out of date and their
> usefulness is brought into question. Often a simple "ls" would reveal
> the same information as the filenames are generally quite descriptive as
> a short introduction to what the file covers (it should not surprise
> anyone what Documentation/sched/sched-design-CFS.txt covers)
> 
> A few years back it was mentioned that these files were no longer really
> needed, and they have since then grown further out of date, so perhaps
> it is time to just throw them out.
[...]
> As a starting point, remove all index-files and references to 00-INDEX and
> see where the discussion is going.

Yes please.

I was *briefly* tempted, reading through the files, to suggest ensuring
that the one-line descriptions from the 00-INDEX files end up in the
documents themselves, but the more I think about it, I don't think even
that is worth anyone's time to do.

Reviewed-by: Josh Triplett <josh@...htriplett.org>