Why there are no READMEs in the Linux filesystem hierarchy

documentationfhs

The Linux filesystem hierarchy (FHS) contains a lot of important directories. For example, I just discovered /sys/class/input while playing with my PS/2 keyboard settings.

But all those important directories are documented elsewhere, so man /sys/class/input doesn't work to explain what happens at a certain point.

Why not place README files into the hierarchy to make it easier for people to learn what's going on at certain levels and play with the contents? It would be really awesome if devices could even mount their own READMEs.

Best Answer

To use your example: /sys/ doesn't contain "real" files, but is entirely provided by the kernel. Do you want all READMEs to become part of the kernel? You probably don't.

Documentation is in /usr/share/doc. Which contains normal files on your harddisk. Some documentation about /sys and /proc is in the kernel source, that is in /usr/src/linux/Documentation (if you've installed the kernel source, and made the symlink for your current kernel).

Related Question