github-mirror/lkmpg
2
0
Fork 0
mirror of https://github.com/sysprog21/lkmpg.git synced 2024-11-22 14:48:25 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
The Linux Kernel Module Programming Guide (updated for 5.0+ kernels)
187 Commits 2 Branches 1 Tag 7.9 MiB
TeX 94.4%
Shell 4.9%
Makefile 0.7%
e8d5bf7fd4
Go to file
Gilad Reti e8d5bf7fd4
fix typo: compatibiity -> compatibility
2021-09-12 08:54:53 +03:00
.ci Remove kbleds from non-working list 2021-09-12 11:47:00 +08:00
.github/workflows Improve CI pipeline to automate module testing (#95) 2021-09-08 20:38:50 +08:00
examples Adapt the timer API Usage (#98) 2021-09-10 12:29:48 +08:00
lib Introduce \src to generate Linux kernel source hyperlinks 2021-08-09 23:01:34 +08:00
.gitignore Update several example code for newer kernel 2021-08-23 21:30:43 +08:00
GPL-2 Initial import 2021-07-22 06:34:19 +08:00
html.cfg Workaround inconsistent text scaling (#100) 2021-09-10 12:08:57 +08:00
LICENSE Initial import 2021-07-22 06:34:19 +08:00
lkmpg.tex fix typo: compatibiity -> compatibility 2021-09-12 08:54:53 +03:00
Makefile Update several example code for newer kernel 2021-08-23 21:30:43 +08:00
README.md Improve top-level documentation 2021-09-10 14:03:09 +00:00

README.md

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.

Getting Started

Summary

  1. Get the latest source code from the GitHub page.
  2. Install the prerequisites.
  3. 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.