Messages in this thread | | | Date | Mon, 26 Nov 2001 14:50:43 +1100 (EST) | From | Grant Bayley <> | Subject | A Documentation suggestion (fwd) |
| |
(I'm not on list due to volume; please reply privately)
---------- Forwarded message ---------- Date: Mon, 26 Nov 2001 14:44:39 +1100 (EST) From: Grant Bayley <gbayley@ausmac.net> To: Alan.Cox@linux.org, torvalds@transmeta.com Subject: A Documentation suggestion
Hi Alan, Linus,
Just wondering if this is the right place to start...
I've been poking around in the Linux Kernel source for some time, and I've always been a bit mystified by the layout of the Documentation directory. Not so much the contents of it, but wondering why the layout is like it is.
Now, without further ado, I've describe what I've done about it.
>From the top level 00-INDEX file: ---------------------------------
This is a brief list of all the files and directories in ./Documentation and what they contain. The layout of this directory closely mirrors that of the Linux kernel itself, and should act as an encouragement to developers to store documentation about their drivers etc. in the appropriate directories.
Files kept at the top level of the Documentation hierarchy are prepended with README- to emphasise the importance of them.
Please try and keep any additional descriptions small enough to fit on one line.
---------------------------
To have a look at the structure and to grab a tarball of the directory, have a squiz here:
http://orbital.wiretapped.net/linux/
The only changes that have been made to the files themselves is correction of a typo in one file and renaming of several others to make the contents of the file more obvious from reading the name (ie pci.txt -> pci-driver-development.txt, pci.txt -> pci-power-management.txt).
Hoping you'd be interested in using such a Documentation directory layout,
Grant
------------------------------------------------------- Grant Bayley gbayley@ausmac.net -Admin @ AusMac Archive, Wiretapped.net, 2600 Australia www.ausmac.net www.wiretapped.net www.2600.org.au -------------------------------------------------------
- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |