The Linux Kernel documentation¶
This is the top level of the kernel’s documentation tree. Kernel documentation, like the kernel itself, is very much a work in progress; that is especially true as we work to integrate our many scattered documents into a coherent whole. Please note that improvements to the documentation are welcome; join the linux-doc list at vger.kernel.org if you want to help out.
The following describes the license of the Linux kernel source code (GPLv2), how to properly mark the license of individual files in the source tree, as well as links to the full license text.
The following manuals are written for users of the kernel — those who are trying to get it to work optimally on a given system.
- The Linux kernel user’s and administrator’s guide
- Linux kernel release 4.x <http://kernel.org/>
- The kernel’s command-line parameters
- Linux allocated devices (4.x+ version)
- L1TF - L1 Terminal Fault
- Reporting bugs
- Security bugs
- Bug hunting
- Bisecting a bug
- Tainted kernels
- Ramoops oops/panic logger
- Dynamic debug
- Explaining the dreaded “No init found.” boot hang message
- Rules on how to access information in sysfs
- Using the initial RAM disk (initrd)
- Control Group v2
- Linux Serial Console
- Linux Braille Console
- RAID arrays
- Kernel module signing facility
- Linux Magic System Request Key Hacks
- Unicode support
- Software cursor for VGA
- Kernel Support for miscellaneous (your favourite) Binary Formats v1.1
- Mono(tm) Binary Kernel Support for Linux
- Java(tm) Binary Kernel Support for Linux v1.03
- Reliability, Availability and Serviceability
- A block layer cache (bcache)
- ext4 General Information
- Power Management
- Linux Security Module Usage
- Memory Management
The user-space API manual gathers together documents describing aspects of the kernel interface as seen by application developers.
Introduction to kernel development¶
These manuals contain overall information about how to develop the kernel. The kernel community is quite large, with thousands of developers contributing over the course of a year. As with any large community, knowing how things are done will make the process of getting your changes merged much easier.
- Kernel Hacking Guides
- Linux Tracing Technologies
- Function Tracer Design
- Notes on Analysing Behaviour Using Events and Tracepoints
- ftrace - Function Tracer
- Using ftrace to hook to functions
- Kprobe-based Event Tracing
- Uprobe-tracer: Uprobe-based Event Tracing
- Using the Linux Kernel Tracepoints
- Event Tracing
- Subsystem Trace Points: kmem
- Subsystem Trace Points: power
- NMI Trace Events
- MSR Trace Events
- In-kernel memory-mapped I/O tracing
- Event Histograms
- Hardware Latency Detector
- Intel(R) Trace Hub (TH)
- System Trace Module
Kernel API documentation¶
These books get into the details of how specific kernel subsystems work from the point of view of a kernel developer. Much of the information here is taken directly from the kernel source, with supplemental material added as needed (or at least as we managed to add it — probably not all that is needed).
These books provide programming details about architecture-specific implementation.
The documentation in this section are provided by specific filesystem subprojects.