github-mirror/lkmpg
2
0
Fork 0
mirror of https://github.com/sysprog21/lkmpg.git synced 2024-11-25 09:01:26 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
The Linux Kernel Module Programming Guide (updated for 5.0+ kernels)
244 Commits 2 Branches 1 Tag 7.9 MiB
TeX 94.4%
Shell 4.9%
Makefile 0.7%
d27d2c2301
Go to file
Chun-Hung Tseng d27d2c2301 Update .gitignore files to ignore latexmk tmp files 
Signed-off-by: Chun-Hung Tseng <henrybear327@gmail.com>
2022-03-18 19:10:23 +01:00
.ci CI: Introduce Smatch for static analysis (#125) 2021-11-01 08:20:41 +08:00
.github/workflows CI: introduce GCC static analysis 2021-10-08 19:41:22 +08:00
assets Add book cover (#136) 2022-01-09 20:26:07 +08:00
examples Improve the description of finding syscall table 2022-03-17 07:51:59 +08:00
lib Introduce \src to generate Linux kernel source hyperlinks 2021-08-09 23:01:34 +08:00
scripts Add script to gen contributor list and contrib.tex 2021-11-03 19:32:48 +08:00
.gitignore Update .gitignore files to ignore latexmk tmp files 2022-03-18 19:10:23 +01:00
.mailmap Add script to gen contributor list and contrib.tex 2021-11-03 19:32:48 +08:00
contrib.tex Add script to gen contributor list and contrib.tex 2021-11-03 19:32:48 +08:00
GPL-2 Initial import 2021-07-22 06:34:19 +08:00
html.cfg Add Manrope variable font (#118) 2021-10-10 21:34:25 +08:00
LICENSE Initial import 2021-07-22 06:34:19 +08:00
lkmpg.tex Refine wording on module loading 2022-03-16 14:32:08 +08:00
Makefile Fix the pdf generation code in Makefile 2022-03-18 19:10:23 +01:00
README.md Merge pull request #128 from sudoliyang/patch-2 2021-11-08 22:30:20 +08: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.
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

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