path: root/Documentation
diff options
authorPavel Pisa <pisa@cmp.felk.cvut.cz>2005-05-01 08:59:25 -0700
committerLinus Torvalds <torvalds@ppc970.osdl.org>2005-05-01 08:59:25 -0700
commit4dc3b16ba18c0f967ad100c52fa65b01a4f76ff0 (patch)
treefa038ad8969980eec6cef5b737872fda9feb4c6a /Documentation
parent333f981720d619e2038b980a55ad01b10580eb9f (diff)
[PATCH] DocBook: changes and extensions to the kernel documentation
I have recompiled Linux kernel documentation for me and our university students again. The documentation could be extended for more sources which are equipped by structured comments for recent 2.6 kernels. I have tried to proceed with that task. I have done that more times from 2.6.0 time and it gets boring to do same changes again and again. Linux kernel compiles after changes for i386 and ARM targets. I have added references to some more files into kernel-api book, I have added some section names as well. So please, check that changes do not break something and that categories are not too much skewed. I have changed kernel-doc to accept "fastcall" and "asmlinkage" words reserved by kernel convention. Most of the other changes are modifications in the comments to make kernel-doc happy, accept some parameters description and do not bail out on errors. Changed <pid> to @pid in the description, moved some #ifdef before comments to correct function to comments bindings, etc. You can see result of the modified documentation build at http://cmp.felk.cvut.cz/~pisa/linux/lkdb-2.6.11.tar.gz Some more sources are ready to be included into kernel-doc generated documentation. Sources has been added into kernel-api for now. Some more section names added and probably some more chaos introduced as result of quick cleanup work. Signed-off-by: Pavel Pisa <pisa@cmp.felk.cvut.cz> Signed-off-by: Martin Waitz <tali@admingilde.org> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Diffstat (limited to 'Documentation')
1 files changed, 179 insertions, 7 deletions
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl
index 1bd20c860285..757cef8f8491 100644
--- a/Documentation/DocBook/kernel-api.tmpl
+++ b/Documentation/DocBook/kernel-api.tmpl
@@ -49,13 +49,33 @@
-<!-- FIXME:
- kernel/sched.c has no docs, which stuffs up the sgml. Comment
- out until somebody adds docs. KAO
<sect1><title>Delaying, scheduling, and timer routines</title>
-KAO -->
+ <sect1><title>Internal Functions</title>
+ </sect1>
+ <sect1><title>Kernel objects manipulation</title>
+ </sect1>
+ <sect1><title>Kernel utility functions</title>
+<!-- This needs to clean up to make kernel-doc happy
+ -->
+ </sect1>
<chapter id="adt">
@@ -81,7 +101,9 @@ KAO -->
<sect1><title>String Manipulation</title>
+<!-- All functions are exported at now
+ -->
<sect1><title>Bit Operations</title>
@@ -98,6 +120,25 @@ KAO -->
+ <sect1><title>More Memory Management Functions</title>
+ </sect1>
+ </chapter>
+ <chapter id="ipc">
+ <title>Kernel IPC facilities</title>
+ <sect1><title>IPC utilities</title>
+ </sect1>
<chapter id="kfifo">
@@ -114,6 +155,10 @@ KAO -->
<sect1><title>sysctl interface</title>
+ <sect1><title>proc filesystem interface</title>
+ </sect1>
<chapter id="debugfs">
@@ -127,6 +172,10 @@ KAO -->
<chapter id="vfs">
<title>The Linux VFS</title>
+ <sect1><title>The Filesystem types</title>
+ </sect1>
<sect1><title>The Directory Cache</title>
@@ -142,13 +191,31 @@ KAO -->
+ <sect1><title>Other Functions</title>
+ </sect1>
<chapter id="netcore">
<title>Linux Networking</title>
+ <sect1><title>Networking Base Types</title>
+ </sect1>
<sect1><title>Socket Buffer Functions</title>
<sect1><title>Socket Filter</title>
@@ -158,6 +225,14 @@ KAO -->
+ <sect1><title>SUN RPC subsystem</title>
+<!-- The !D functionality is not perfect, garbage has to be protected by comments
+ </sect1>
<chapter id="netdev">
@@ -194,11 +269,26 @@ X!Ekernel/module.c
+ <sect1><title>Resources Management</title>
+ </sect1>
<sect1><title>MTRR Handling</title>
<sect1><title>PCI Support Library</title>
+<!-- kerneldoc does not understand to __devinit
+ -->
<sect1><title>PCI Hotplug Support Library</title>
@@ -223,6 +313,14 @@ X!Earch/i386/kernel/mca.c
+ <chapter id="sysfs">
+ <title>The Filesystem for Exporting Kernel Objects</title>
+ </chapter>
<chapter id="security">
<title>Security Framework</title>
@@ -233,6 +331,61 @@ X!Earch/i386/kernel/mca.c
+ <chapter id="devdrivers">
+ <title>Device drivers infrastructure</title>
+ <sect1><title>Device Drivers Base</title>
+<!-- Cannot be included, because
+ attribute_container_add_class_device_adapter
+ and attribute_container_classdev_to_container
+ exceed allowed 44 characters maximum
+ </sect1>
+ <sect1><title>Device Drivers Power Management</title>
+ </sect1>
+ <sect1><title>Device Drivers ACPI Support</title>
+<!-- Internal functions only
+<!-- No correct structured comments
+ </sect1>
+ <sect1><title>Device drivers PnP support</title>
+<!-- No correct structured comments
+ -->
+ </sect1>
+ </chapter>
<chapter id="blkdev">
<title>Block Devices</title>
@@ -250,7 +403,23 @@ X!Earch/i386/kernel/mca.c
<chapter id="snddev">
<title>Sound Devices</title>
<!-- FIXME: Removed for now since no structured comments in source
@@ -258,6 +427,7 @@ X!Isound/sound_firmware.c
<chapter id="uart16x50">
<title>16x50 UART Driver</title>
@@ -310,9 +480,11 @@ X!Isound/sound_firmware.c
<sect1><title>Frame Buffer Memory</title>
<sect1><title>Frame Buffer Console</title>
<sect1><title>Frame Buffer Colormap</title>

Privacy Policy