Skip to content

Commit

Permalink
Drop all 00-INDEX files from Documentation/
Browse files Browse the repository at this point in the history
This is a respin with a wider audience (all that get_maintainer returned)
and I know this spams a *lot* of people. Not sure what would be the correct
way, so my apologies for ruining your inbox.

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.

A short status yields the following _outdated_ 00-INDEX files, first
counter is files listed in 00-INDEX but missing in the directory, last
is files present but not listed in 00-INDEX.

List of outdated 00-INDEX:
Documentation: (4/10)
Documentation/sysctl: (0/1)
Documentation/timers: (1/0)
Documentation/blockdev: (3/1)
Documentation/w1/slaves: (0/1)
Documentation/locking: (0/1)
Documentation/devicetree: (0/5)
Documentation/power: (1/1)
Documentation/powerpc: (0/5)
Documentation/arm: (1/0)
Documentation/x86: (0/9)
Documentation/x86/x86_64: (1/1)
Documentation/scsi: (4/4)
Documentation/filesystems: (2/9)
Documentation/filesystems/nfs: (0/2)
Documentation/cgroup-v1: (0/2)
Documentation/kbuild: (0/4)
Documentation/spi: (1/0)
Documentation/virtual/kvm: (1/0)
Documentation/scheduler: (0/2)
Documentation/fb: (0/1)
Documentation/block: (0/1)
Documentation/networking: (6/37)
Documentation/vm: (1/3)

Then there are 364 subdirectories in Documentation/ with several files that
are missing 00-INDEX alltogether (and another 120 with a single file and no
00-INDEX).

I don't really have an opinion to whether or not we /should/ have 00-INDEX,
but the above 00-INDEX should either be removed or be kept up to date. If
we should keep the files, I can try to keep them updated, but I rather not
if we just want to delete them anyway.

As a starting point, remove all index-files and references to 00-INDEX and
see where the discussion is going.

Signed-off-by: Henrik Austad <henrik@austad.us>
Acked-by: "Paul E. McKenney" <paulmck@linux.vnet.ibm.com>
Just-do-it-by: Steven Rostedt <rostedt@goodmis.org>
Reviewed-by: Jens Axboe <axboe@kernel.dk>
Acked-by: Paul Moore <paul@paul-moore.com>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: Mark Brown <broonie@kernel.org>
Acked-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Cc: [Almost everybody else]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
henrikau authored and Jonathan Corbet committed Sep 9, 2018
1 parent 9d92e48 commit a7ddcea
Show file tree
Hide file tree
Showing 50 changed files with 8 additions and 1,896 deletions.
428 changes: 0 additions & 428 deletions Documentation/00-INDEX

This file was deleted.

26 changes: 0 additions & 26 deletions Documentation/PCI/00-INDEX

This file was deleted.

34 changes: 0 additions & 34 deletions Documentation/RCU/00-INDEX

This file was deleted.

4 changes: 0 additions & 4 deletions Documentation/RCU/rcu.txt
Expand Up @@ -87,7 +87,3 @@ o Where can I find more information on RCU?

See the RTFP.txt file in this directory.
Or point your browser at http://www.rdrop.com/users/paulmck/RCU/.

o What are all these files in this directory?

See 00-INDEX for the list.
3 changes: 1 addition & 2 deletions Documentation/admin-guide/README.rst
Expand Up @@ -51,8 +51,7 @@ Documentation

- There are various README files in the Documentation/ subdirectory:
these typically contain kernel-specific installation notes for some
drivers for example. See Documentation/00-INDEX for a list of what
is contained in each file. Please read the
drivers for example. Please read the
:ref:`Documentation/process/changes.rst <changes>` file, as it
contains information about the problems, which may result by upgrading
your kernel.
Expand Down
50 changes: 0 additions & 50 deletions Documentation/arm/00-INDEX

This file was deleted.

34 changes: 0 additions & 34 deletions Documentation/block/00-INDEX

This file was deleted.

18 changes: 0 additions & 18 deletions Documentation/blockdev/00-INDEX

This file was deleted.

11 changes: 0 additions & 11 deletions Documentation/cdrom/00-INDEX

This file was deleted.

26 changes: 0 additions & 26 deletions Documentation/cgroup-v1/00-INDEX

This file was deleted.

12 changes: 0 additions & 12 deletions Documentation/devicetree/00-INDEX

This file was deleted.

75 changes: 0 additions & 75 deletions Documentation/fb/00-INDEX

This file was deleted.

0 comments on commit a7ddcea

Please sign in to comment.