Repository files navigation

This project keeps the Linux Kernel Module Programming Guide up to date, withworking 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 viahttps://sysprog21.github.io/lkmpg/ orlatest PDF file.The original guide may be found atLinux Documentation Project.You may check otherfreely available programming books listed by TheFree Ebook Foundation orLinux online books collected byThe Online Books Page.

1. Get the latest source code from theGitHub page.
2. Install the prerequisites.
3. Generate PDF and/or HTML documents.

Make sure you can rungit with an Internet connection.

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

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 thatlatexmk is required to generated PDF, and it probably has been installed on your OS already. If not, please follow theinstallation guide.

In macOS systems, packagePygments may not be pre-installed. If not, please refer to theinstallation guide before generate documents.

Alternatively, usingDocker is recommended, as it guarantees the same dependencies with our GitHub Actions workflow.After installdocker engine on your machine, pull the docker imagetwtug/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 forcontainerd, and you can replace the abovedocker commands withnerdctl counterparts.

Now we could build document with following commands:

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

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

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