<feed xmlns='http://www.w3.org/2005/Atom'>
<title>linux/Documentation/locking/00-INDEX, branch master</title>
<subtitle>Mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/
</subtitle>
<id>https://git.shady.money/linux/atom?h=master</id>
<link rel='self' href='https://git.shady.money/linux/atom?h=master'/>
<link rel='alternate' type='text/html' href='https://git.shady.money/linux/'/>
<updated>2018-09-09T21:08:58Z</updated>
<entry>
<title>Drop all 00-INDEX files from Documentation/</title>
<updated>2018-09-09T21:08:58Z</updated>
<author>
<name>Henrik Austad</name>
<email>henrik@austad.us</email>
</author>
<published>2018-09-03T22:15:23Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/linux/commit/?id=a7ddcea58ae22d85d94eabfdd3de75c3742e376b'/>
<id>urn:sha1:a7ddcea58ae22d85d94eabfdd3de75c3742e376b</id>
<content type='text'>
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 &lt;henrik@austad.us&gt;
Acked-by: "Paul E. McKenney" &lt;paulmck@linux.vnet.ibm.com&gt;
Just-do-it-by: Steven Rostedt &lt;rostedt@goodmis.org&gt;
Reviewed-by: Jens Axboe &lt;axboe@kernel.dk&gt;
Acked-by: Paul Moore &lt;paul@paul-moore.com&gt;
Acked-by: Greg Kroah-Hartman &lt;gregkh@linuxfoundation.org&gt;
Acked-by: Mark Brown &lt;broonie@kernel.org&gt;
Acked-by: Mike Rapoport &lt;rppt@linux.vnet.ibm.com&gt;
Cc: [Almost everybody else]
Signed-off-by: Jonathan Corbet &lt;corbet@lwn.net&gt;
</content>
</entry>
<entry>
<title>Update of Documentation/00-INDEX</title>
<updated>2014-12-29T22:27:54Z</updated>
<author>
<name>Henrik Austad</name>
<email>henrik@austad.us</email>
</author>
<published>2014-12-26T08:26:22Z</published>
<link rel='alternate' type='text/html' href='https://git.shady.money/linux/commit/?id=8ea8f3eb9c6aee87e23907fc263108a0f9091c71'/>
<id>urn:sha1:8ea8f3eb9c6aee87e23907fc263108a0f9091c71</id>
<content type='text'>
Added files
- hsi.txt was added by 3a8ab8af (HSI: Add some general description for
  the HSI subsystem)
- lzo.txt was added by d98a0526 (lzo: document part of the encoding)
- xillybus.txt was added by 7051924f (xillybus: Move out of staging)
- mailbox.txt was added by 15320fbc (add documentation for mailbox
  framework)

Moved files
- xommit 214e0aed (Move locking related docs into Documentation/locking/):
  * lockdep-design.txt
  * lockstat.txt
  * mutex-design.txt
  * rt-mutex-design.txt
  * rt-mutex.txt
  * spinlocks.txt
  * ww-mutex-design.txt
- kselftest.txt was moved by 3c415707 (kselftest: Move the docs to the
  Documentation dir)

CC: Davidlohr Bueso &lt;davidlohr@hp.com&gt;
CC: Willy Tarreau &lt;w@1wt.eu&gt;
CC: Randy Dunlap &lt;rdunlap@infradead.org&gt;
CC: Greg Kroah-Hartman &lt;gregkh@linuxfoundation.org&gt;
CC: Sebastian Reichel &lt;sre@kernel.org&gt;
CC: Eli Billauer &lt;eli.billauer@gmail.com&gt;
CC: Jonathan Corbet &lt;corbet@lwn.net&gt;
CC: Jiri Kosina &lt;trivial@kernel.org&gt;
CC: linux-doc@vger.kernel.org
CC: linux-kernel@vger.kernel.org
Cc: Tim Bird &lt;tim.bird@sonymobile.com&gt;
Cc: Shuah Khan &lt;shuahkh@osg.samsung.com&gt;

Signed-off-by: Henrik Austad &lt;henrik@austad.us&gt;
Signed-off-by: Jonathan Corbet &lt;corbet@lwn.net&gt;
</content>
</entry>
</feed>
