暂无描述

Jimmy Ma 3682d9e6d5 Move bottom-half to workqueue for safe sleep		2 月之前
.ci	a16a278556 Mark 'syscall-steal' as non-working module	4 月之前
.github	9543ca4e40 CI: Install libsqlite3 required by Sparse	4 月之前
assets	fb15882377 Add book cover (#136)	3 年之前
examples	3682d9e6d5 Move bottom-half to workqueue for safe sleep	2 月之前
lib	2d368210ce Introduce \src to generate Linux kernel source hyperlinks	3 年之前
scripts	b5709f89f8 Update contributor list	11 月之前
.gitignore	be9aa2cd4d Exclude generated files	1 年之前
.mailmap	b5709f89f8 Update contributor list	11 月之前
GPL-2	826b45b3d9 Initial import	3 年之前
LICENSE	826b45b3d9 Initial import	3 年之前
Makefile	16fe2e9eb0 Update README and Makefile for the latexmk existence check	3 年之前
README.md	209aa95a38 Explicitly mention 6.x kernels	1 年之前
contrib.tex	b5709f89f8 Update contributor list	11 月之前
html.cfg	dbac3869c7 Add Manrope variable font (#118)	3 年之前
lkmpg.tex	1bb3f64bc1 Fix a typo	2 月之前

The Linux Kernel Module Programming Guide

This project keeps the Linux Kernel Module Programming Guide up to date, with working examples for recent 5.x and 6.x kernel versions. The guide has been around since 2001 and most copies of it on the web only describe old 2.6.x kernels.

The book can be freely accessed via https://sysprog21.github.io/lkmpg/ or latest PDF file. The original guide may be found at Linux Documentation Project. You may check other freely available programming books listed by The Free Ebook Foundation or Linux online books collected by The Online Books Page.

Getting Started

Summary

Get the latest source code from the GitHub page.
Install the prerequisites.
Generate PDF and/or HTML documents.

Step 1: Get the latest source code

Make sure you can run git with an Internet connection.

$ git clone https://github.com/sysprog21/lkmpg.git && cd lkmpg

Step 2: Install the prerequisites

To generate the book from source, TeXLive (MacTeX) is required.

For Ubuntu Linux, macOS, and other Unix-like systems, run the following command(s):

# Debian / Ubuntu
$ sudo apt install make texlive-full

# Arch / Manjaro
$ sudo pacman -S make texlive-binextra texlive-bin

# macOS
$ brew install mactex
$ sudo tlmgr update --self

Note that latexmk is required to generated PDF, and it probably has been installed on your OS already. If not, please follow the installation guide.

In macOS systems, package Pygments may not be pre-installed. If not, please refer to the installation guide before generate documents.

Alternatively, using Docker is recommended, as it guarantees the same dependencies with our GitHub Actions workflow. After install docker engine on your machine, pull the docker image twtug/lkmpg and run in isolated containers.

# pull docker image and run it as container
$ docker pull twtug/lkmpg
$ docker run --rm -it -v $(pwd):/workdir twtug/lkmpg

nerdctl is a Docker-compatible command line tool for containerd, and you can replace the above docker commands with nerdctl counterparts.

Step 3: Generate PDF and/or HTML documents

Now we could build document with following commands:

$ make all              # Generate PDF document
$ make html             # Convert TeX to HTML
$ make clean            # Delete generated files

License

The Linux Kernel Module Programming Guide is a free book; you may reproduce and/or modify it under the terms of the Open Software License. Use of this work is governed by a copyleft license that can be found in the LICENSE file.

The complementary sample code is licensed under GNU GPL version 2, as same as Linux kernel.

README.md