The fundamentals

This project provides the Linux kernel API reference documentation. It is generated automatically by the Doxygen program using the comments in the standard kernel headers. These comments are pre-processed by some regular expression transformation rules to conformize them for good Doxygen processing.

Please note the kernel headers are commented only a little bit. Thus the reference documentation cannot contain more descriptive text than it contains (not counting occasional errors of course).

Goals of this project

1. New modules development support. Module developers need to know the kernel API. But there are no information resources which provide the API reference itself. This project is dedicated to solve this problem.
2. Driver porting simplification. The very common bottleneck for module porting is kernel API information deficiency. This project allows to compare APIs of Linux and the other operating system effectively and decide how to port the given driver.
3. Linux version comparison. The Linux kernel is under heavy development. New features are built up and some others are going deprecated (and are possibly removed later). This project documents the all Linux 2.6 versions and everyone can use it to track the API changes.
4. Kernel understanding issues. Many people want to know how the Linux kernel works but they are bored by reading the source files. This project can help them to make the first step although it cannot provide informations about the kernel internals.

This project is not intended to be a replacement for the Linux Cross-Reference but its counterpart.

License

The documentation is licensed under the terms of the same license as the Linux kernel itself, the GNU General Public License, version 2. Please read it carefully.

Disclaimer

All the documentation is provided "as is" without any warranty both explicit nor implied. Use it only at your own risk. The documents may contain bugs, be incomplete or obsolete.

Bug reporting, feature suggestions

For reporting bugs, suggesting features or other issues related to this project please use our bug tracking system. Thank you.