diff options
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/kernel-api.tmpl | 186 |
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 @@ | |||
49 | !Iinclude/asm-i386/unaligned.h | 49 | !Iinclude/asm-i386/unaligned.h |
50 | </sect1> | 50 | </sect1> |
51 | 51 | ||
52 | <!-- FIXME: | ||
53 | kernel/sched.c has no docs, which stuffs up the sgml. Comment | ||
54 | out until somebody adds docs. KAO | ||
55 | <sect1><title>Delaying, scheduling, and timer routines</title> | 52 | <sect1><title>Delaying, scheduling, and timer routines</title> |
56 | X!Ekernel/sched.c | 53 | !Iinclude/linux/sched.h |
54 | !Ekernel/sched.c | ||
55 | !Ekernel/timer.c | ||
57 | </sect1> | 56 | </sect1> |
58 | KAO --> | 57 | <sect1><title>Internal Functions</title> |
58 | !Ikernel/exit.c | ||
59 | !Ikernel/signal.c | ||
60 | </sect1> | ||
61 | |||
62 | <sect1><title>Kernel objects manipulation</title> | ||
63 | <!-- | ||
64 | X!Iinclude/linux/kobject.h | ||
65 | --> | ||
66 | !Elib/kobject.c | ||
67 | </sect1> | ||
68 | |||
69 | <sect1><title>Kernel utility functions</title> | ||
70 | !Iinclude/linux/kernel.h | ||
71 | <!-- This needs to clean up to make kernel-doc happy | ||
72 | X!Ekernel/printk.c | ||
73 | --> | ||
74 | !Ekernel/panic.c | ||
75 | !Ekernel/sys.c | ||
76 | !Ekernel/rcupdate.c | ||
77 | </sect1> | ||
78 | |||
59 | </chapter> | 79 | </chapter> |
60 | 80 | ||
61 | <chapter id="adt"> | 81 | <chapter id="adt"> |
@@ -81,7 +101,9 @@ KAO --> | |||
81 | !Elib/vsprintf.c | 101 | !Elib/vsprintf.c |
82 | </sect1> | 102 | </sect1> |
83 | <sect1><title>String Manipulation</title> | 103 | <sect1><title>String Manipulation</title> |
84 | !Ilib/string.c | 104 | <!-- All functions are exported at now |
105 | X!Ilib/string.c | ||
106 | --> | ||
85 | !Elib/string.c | 107 | !Elib/string.c |
86 | </sect1> | 108 | </sect1> |
87 | <sect1><title>Bit Operations</title> | 109 | <sect1><title>Bit Operations</title> |
@@ -98,6 +120,25 @@ KAO --> | |||
98 | !Iinclude/asm-i386/uaccess.h | 120 | !Iinclude/asm-i386/uaccess.h |
99 | !Iarch/i386/lib/usercopy.c | 121 | !Iarch/i386/lib/usercopy.c |
100 | </sect1> | 122 | </sect1> |
123 | <sect1><title>More Memory Management Functions</title> | ||
124 | !Iinclude/linux/rmap.h | ||
125 | !Emm/readahead.c | ||
126 | !Emm/filemap.c | ||
127 | !Emm/memory.c | ||
128 | !Emm/vmalloc.c | ||
129 | !Emm/mempool.c | ||
130 | !Emm/page-writeback.c | ||
131 | !Emm/truncate.c | ||
132 | </sect1> | ||
133 | </chapter> | ||
134 | |||
135 | |||
136 | <chapter id="ipc"> | ||
137 | <title>Kernel IPC facilities</title> | ||
138 | |||
139 | <sect1><title>IPC utilities</title> | ||
140 | !Iipc/util.c | ||
141 | </sect1> | ||
101 | </chapter> | 142 | </chapter> |
102 | 143 | ||
103 | <chapter id="kfifo"> | 144 | <chapter id="kfifo"> |
@@ -114,6 +155,10 @@ KAO --> | |||
114 | <sect1><title>sysctl interface</title> | 155 | <sect1><title>sysctl interface</title> |
115 | !Ekernel/sysctl.c | 156 | !Ekernel/sysctl.c |
116 | </sect1> | 157 | </sect1> |
158 | |||
159 | <sect1><title>proc filesystem interface</title> | ||
160 | !Ifs/proc/base.c | ||
161 | </sect1> | ||
117 | </chapter> | 162 | </chapter> |
118 | 163 | ||
119 | <chapter id="debugfs"> | 164 | <chapter id="debugfs"> |
@@ -127,6 +172,10 @@ KAO --> | |||
127 | 172 | ||
128 | <chapter id="vfs"> | 173 | <chapter id="vfs"> |
129 | <title>The Linux VFS</title> | 174 | <title>The Linux VFS</title> |
175 | <sect1><title>The Filesystem types</title> | ||
176 | !Iinclude/linux/fs.h | ||
177 | !Einclude/linux/fs.h | ||
178 | </sect1> | ||
130 | <sect1><title>The Directory Cache</title> | 179 | <sect1><title>The Directory Cache</title> |
131 | !Efs/dcache.c | 180 | !Efs/dcache.c |
132 | !Iinclude/linux/dcache.h | 181 | !Iinclude/linux/dcache.h |
@@ -142,13 +191,31 @@ KAO --> | |||
142 | !Efs/locks.c | 191 | !Efs/locks.c |
143 | !Ifs/locks.c | 192 | !Ifs/locks.c |
144 | </sect1> | 193 | </sect1> |
194 | <sect1><title>Other Functions</title> | ||
195 | !Efs/mpage.c | ||
196 | !Efs/namei.c | ||
197 | !Efs/buffer.c | ||
198 | !Efs/bio.c | ||
199 | !Efs/seq_file.c | ||
200 | !Efs/filesystems.c | ||
201 | !Efs/fs-writeback.c | ||
202 | !Efs/block_dev.c | ||
203 | </sect1> | ||
145 | </chapter> | 204 | </chapter> |
146 | 205 | ||
147 | <chapter id="netcore"> | 206 | <chapter id="netcore"> |
148 | <title>Linux Networking</title> | 207 | <title>Linux Networking</title> |
208 | <sect1><title>Networking Base Types</title> | ||
209 | !Iinclude/linux/net.h | ||
210 | </sect1> | ||
149 | <sect1><title>Socket Buffer Functions</title> | 211 | <sect1><title>Socket Buffer Functions</title> |
150 | !Iinclude/linux/skbuff.h | 212 | !Iinclude/linux/skbuff.h |
213 | !Iinclude/net/sock.h | ||
214 | !Enet/socket.c | ||
151 | !Enet/core/skbuff.c | 215 | !Enet/core/skbuff.c |
216 | !Enet/core/sock.c | ||
217 | !Enet/core/datagram.c | ||
218 | !Enet/core/stream.c | ||
152 | </sect1> | 219 | </sect1> |
153 | <sect1><title>Socket Filter</title> | 220 | <sect1><title>Socket Filter</title> |
154 | !Enet/core/filter.c | 221 | !Enet/core/filter.c |
@@ -158,6 +225,14 @@ KAO --> | |||
158 | !Enet/core/gen_stats.c | 225 | !Enet/core/gen_stats.c |
159 | !Enet/core/gen_estimator.c | 226 | !Enet/core/gen_estimator.c |
160 | </sect1> | 227 | </sect1> |
228 | <sect1><title>SUN RPC subsystem</title> | ||
229 | <!-- The !D functionality is not perfect, garbage has to be protected by comments | ||
230 | !Dnet/sunrpc/sunrpc_syms.c | ||
231 | --> | ||
232 | !Enet/sunrpc/xdr.c | ||
233 | !Enet/sunrpc/svcsock.c | ||
234 | !Enet/sunrpc/sched.c | ||
235 | </sect1> | ||
161 | </chapter> | 236 | </chapter> |
162 | 237 | ||
163 | <chapter id="netdev"> | 238 | <chapter id="netdev"> |
@@ -194,11 +269,26 @@ X!Ekernel/module.c | |||
194 | !Iarch/i386/kernel/irq.c | 269 | !Iarch/i386/kernel/irq.c |
195 | </sect1> | 270 | </sect1> |
196 | 271 | ||
272 | <sect1><title>Resources Management</title> | ||
273 | !Ekernel/resource.c | ||
274 | </sect1> | ||
275 | |||
197 | <sect1><title>MTRR Handling</title> | 276 | <sect1><title>MTRR Handling</title> |
198 | !Earch/i386/kernel/cpu/mtrr/main.c | 277 | !Earch/i386/kernel/cpu/mtrr/main.c |
199 | </sect1> | 278 | </sect1> |
200 | <sect1><title>PCI Support Library</title> | 279 | <sect1><title>PCI Support Library</title> |
201 | !Edrivers/pci/pci.c | 280 | !Edrivers/pci/pci.c |
281 | !Edrivers/pci/pci-driver.c | ||
282 | !Edrivers/pci/remove.c | ||
283 | !Edrivers/pci/pci-acpi.c | ||
284 | <!-- kerneldoc does not understand to __devinit | ||
285 | X!Edrivers/pci/search.c | ||
286 | --> | ||
287 | !Edrivers/pci/msi.c | ||
288 | !Edrivers/pci/bus.c | ||
289 | !Edrivers/pci/hotplug.c | ||
290 | !Edrivers/pci/probe.c | ||
291 | !Edrivers/pci/rom.c | ||
202 | </sect1> | 292 | </sect1> |
203 | <sect1><title>PCI Hotplug Support Library</title> | 293 | <sect1><title>PCI Hotplug Support Library</title> |
204 | !Edrivers/pci/hotplug/pci_hotplug_core.c | 294 | !Edrivers/pci/hotplug/pci_hotplug_core.c |
@@ -223,6 +313,14 @@ X!Earch/i386/kernel/mca.c | |||
223 | !Efs/devfs/base.c | 313 | !Efs/devfs/base.c |
224 | </chapter> | 314 | </chapter> |
225 | 315 | ||
316 | <chapter id="sysfs"> | ||
317 | <title>The Filesystem for Exporting Kernel Objects</title> | ||
318 | !Efs/sysfs/file.c | ||
319 | !Efs/sysfs/dir.c | ||
320 | !Efs/sysfs/symlink.c | ||
321 | !Efs/sysfs/bin.c | ||
322 | </chapter> | ||
323 | |||
226 | <chapter id="security"> | 324 | <chapter id="security"> |
227 | <title>Security Framework</title> | 325 | <title>Security Framework</title> |
228 | !Esecurity/security.c | 326 | !Esecurity/security.c |
@@ -233,6 +331,61 @@ X!Earch/i386/kernel/mca.c | |||
233 | !Ekernel/power/pm.c | 331 | !Ekernel/power/pm.c |
234 | </chapter> | 332 | </chapter> |
235 | 333 | ||
334 | <chapter id="devdrivers"> | ||
335 | <title>Device drivers infrastructure</title> | ||
336 | <sect1><title>Device Drivers Base</title> | ||
337 | <!-- | ||
338 | X!Iinclude/linux/device.h | ||
339 | --> | ||
340 | !Edrivers/base/driver.c | ||
341 | !Edrivers/base/class_simple.c | ||
342 | !Edrivers/base/core.c | ||
343 | !Edrivers/base/firmware_class.c | ||
344 | !Edrivers/base/transport_class.c | ||
345 | !Edrivers/base/dmapool.c | ||
346 | <!-- Cannot be included, because | ||
347 | attribute_container_add_class_device_adapter | ||
348 | and attribute_container_classdev_to_container | ||
349 | exceed allowed 44 characters maximum | ||
350 | X!Edrivers/base/attribute_container.c | ||
351 | --> | ||
352 | !Edrivers/base/sys.c | ||
353 | <!-- | ||
354 | X!Edrivers/base/interface.c | ||
355 | --> | ||
356 | !Edrivers/base/platform.c | ||
357 | !Edrivers/base/bus.c | ||
358 | </sect1> | ||
359 | <sect1><title>Device Drivers Power Management</title> | ||
360 | !Edrivers/base/power/main.c | ||
361 | !Edrivers/base/power/resume.c | ||
362 | !Edrivers/base/power/suspend.c | ||
363 | </sect1> | ||
364 | <sect1><title>Device Drivers ACPI Support</title> | ||
365 | <!-- Internal functions only | ||
366 | X!Edrivers/acpi/sleep/main.c | ||
367 | X!Edrivers/acpi/sleep/wakeup.c | ||
368 | X!Edrivers/acpi/motherboard.c | ||
369 | X!Edrivers/acpi/bus.c | ||
370 | --> | ||
371 | !Edrivers/acpi/scan.c | ||
372 | <!-- No correct structured comments | ||
373 | X!Edrivers/acpi/pci_bind.c | ||
374 | --> | ||
375 | </sect1> | ||
376 | <sect1><title>Device drivers PnP support</title> | ||
377 | !Edrivers/pnp/core.c | ||
378 | <!-- No correct structured comments | ||
379 | X!Edrivers/pnp/system.c | ||
380 | --> | ||
381 | !Edrivers/pnp/card.c | ||
382 | !Edrivers/pnp/driver.c | ||
383 | !Edrivers/pnp/manager.c | ||
384 | !Edrivers/pnp/support.c | ||
385 | </sect1> | ||
386 | </chapter> | ||
387 | |||
388 | |||
236 | <chapter id="blkdev"> | 389 | <chapter id="blkdev"> |
237 | <title>Block Devices</title> | 390 | <title>Block Devices</title> |
238 | !Edrivers/block/ll_rw_blk.c | 391 | !Edrivers/block/ll_rw_blk.c |
@@ -250,7 +403,23 @@ X!Earch/i386/kernel/mca.c | |||
250 | 403 | ||
251 | <chapter id="snddev"> | 404 | <chapter id="snddev"> |
252 | <title>Sound Devices</title> | 405 | <title>Sound Devices</title> |
406 | !Iinclude/sound/core.h | ||
253 | !Esound/sound_core.c | 407 | !Esound/sound_core.c |
408 | !Iinclude/sound/pcm.h | ||
409 | !Esound/core/pcm.c | ||
410 | !Esound/core/device.c | ||
411 | !Esound/core/info.c | ||
412 | !Esound/core/rawmidi.c | ||
413 | !Esound/core/sound.c | ||
414 | !Esound/core/memory.c | ||
415 | !Esound/core/pcm_memory.c | ||
416 | !Esound/core/init.c | ||
417 | !Esound/core/isadma.c | ||
418 | !Esound/core/control.c | ||
419 | !Esound/core/pcm_lib.c | ||
420 | !Esound/core/hwdep.c | ||
421 | !Esound/core/pcm_native.c | ||
422 | !Esound/core/memalloc.c | ||
254 | <!-- FIXME: Removed for now since no structured comments in source | 423 | <!-- FIXME: Removed for now since no structured comments in source |
255 | X!Isound/sound_firmware.c | 424 | X!Isound/sound_firmware.c |
256 | --> | 425 | --> |
@@ -258,6 +427,7 @@ X!Isound/sound_firmware.c | |||
258 | 427 | ||
259 | <chapter id="uart16x50"> | 428 | <chapter id="uart16x50"> |
260 | <title>16x50 UART Driver</title> | 429 | <title>16x50 UART Driver</title> |
430 | !Iinclude/linux/serial_core.h | ||
261 | !Edrivers/serial/serial_core.c | 431 | !Edrivers/serial/serial_core.c |
262 | !Edrivers/serial/8250.c | 432 | !Edrivers/serial/8250.c |
263 | </chapter> | 433 | </chapter> |
@@ -310,9 +480,11 @@ X!Isound/sound_firmware.c | |||
310 | <sect1><title>Frame Buffer Memory</title> | 480 | <sect1><title>Frame Buffer Memory</title> |
311 | !Edrivers/video/fbmem.c | 481 | !Edrivers/video/fbmem.c |
312 | </sect1> | 482 | </sect1> |
483 | <!-- | ||
313 | <sect1><title>Frame Buffer Console</title> | 484 | <sect1><title>Frame Buffer Console</title> |
314 | !Edrivers/video/console/fbcon.c | 485 | X!Edrivers/video/console/fbcon.c |
315 | </sect1> | 486 | </sect1> |
487 | --> | ||
316 | <sect1><title>Frame Buffer Colormap</title> | 488 | <sect1><title>Frame Buffer Colormap</title> |
317 | !Edrivers/video/fbcmap.c | 489 | !Edrivers/video/fbcmap.c |
318 | </sect1> | 490 | </sect1> |