暂无描述

Jim Huang 09e636cc80 Merge pull request #107 from sprowell/master		3 年之前
.ci	25d82ec47f CI: Integrate the Sparse into the CI pipeline	3 年之前
.github	5070fcd9d0 CI: Run static analysis with Cppcheck (#105)	3 年之前
examples	5070fcd9d0 CI: Run static analysis with Cppcheck (#105)	3 年之前
lib	2d368210ce Introduce \src to generate Linux kernel source hyperlinks	3 年之前
.gitignore	870b26fa2d Update several example code for newer kernel	3 年之前
GPL-2	826b45b3d9 Initial import	3 年之前
LICENSE	826b45b3d9 Initial import	3 年之前
Makefile	870b26fa2d Update several example code for newer kernel	3 年之前
README.md	42a21d2c55 Mention Free Ebook Foundation	3 年之前
html.cfg	d5c43420c8 Workaround inconsistent text scaling (#100)	3 年之前
lkmpg.tex	728b7fd432 Fixed parameter name for hello-5.	3 年之前

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 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.

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 gernate 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-most texlive-bin

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

Alternatively, using Docker is recommended, as it guarantees the same dependencies with our GitHub Actions wokrflow. 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