Skip to content

Commit a7ddcea

Browse files
henrikauJonathan Corbet
authored and
Jonathan Corbet
committed
Drop all 00-INDEX files from Documentation/
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 <[email protected]> Acked-by: "Paul E. McKenney" <[email protected]> Just-do-it-by: Steven Rostedt <[email protected]> Reviewed-by: Jens Axboe <[email protected]> Acked-by: Paul Moore <[email protected]> Acked-by: Greg Kroah-Hartman <[email protected]> Acked-by: Mark Brown <[email protected]> Acked-by: Mike Rapoport <[email protected]> Cc: [Almost everybody else] Signed-off-by: Jonathan Corbet <[email protected]>
1 parent 9d92e48 commit a7ddcea

File tree

50 files changed

+8
-1896
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+8
-1896
lines changed

Documentation/00-INDEX

-428
This file was deleted.

Documentation/PCI/00-INDEX

-26
This file was deleted.

Documentation/RCU/00-INDEX

-34
This file was deleted.

Documentation/RCU/rcu.txt

-4
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,3 @@ o Where can I find more information on RCU?
8787

8888
See the RTFP.txt file in this directory.
8989
Or point your browser at http://www.rdrop.com/users/paulmck/RCU/.
90-
91-
o What are all these files in this directory?
92-
93-
See 00-INDEX for the list.

Documentation/admin-guide/README.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,7 @@ Documentation
5151

5252
- There are various README files in the Documentation/ subdirectory:
5353
these typically contain kernel-specific installation notes for some
54-
drivers for example. See Documentation/00-INDEX for a list of what
55-
is contained in each file. Please read the
54+
drivers for example. Please read the
5655
:ref:`Documentation/process/changes.rst <changes>` file, as it
5756
contains information about the problems, which may result by upgrading
5857
your kernel.

Documentation/arm/00-INDEX

-50
This file was deleted.

Documentation/block/00-INDEX

-34
This file was deleted.

Documentation/blockdev/00-INDEX

-18
This file was deleted.

Documentation/cdrom/00-INDEX

-11
This file was deleted.

Documentation/cgroup-v1/00-INDEX

-26
This file was deleted.

Documentation/devicetree/00-INDEX

-12
This file was deleted.

Documentation/fb/00-INDEX

-75
This file was deleted.

0 commit comments

Comments
 (0)