github-mirror/lkmpg
2
0
Fork 0
mirror of https://github.com/sysprog21/lkmpg.git synced 2024-11-22 04:09:18 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
The Linux Kernel Module Programming Guide (updated for 5.0+ kernels)
176 Commits 2 Branches 1 Tag 7.9 MiB
TeX 94.4%
Shell 4.9%
Makefile 0.7%
9289bfe59c
Go to file
linD026 9289bfe59c
Fix the warnings raised by Sparse (#92) 
Sparse[1] is a semantic parser, capable of finding out the potential
problems of Linux kernel code. This patch fixed the warnings.

[1] https://www.kernel.org/doc/html/latest/dev-tools/sparse.html
2021-09-04 17:53:29 +08:00
.ci Check coding style in CI 2021-08-17 13:07:06 +08:00
.github/workflows Check coding style in CI 2021-08-17 13:07:06 +08:00
examples Fix the warnings raised by Sparse (#92) 2021-09-04 17:53:29 +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 Add GitHub buttons in rendered HTML (#85) 2021-08-31 23:49:18 +08:00
LICENSE Initial import 2021-07-22 06:34:19 +08:00
lkmpg.tex Fix Typo 2021-09-03 23:02:17 +08:00
Makefile Update several example code for newer kernel 2021-08-23 21:30:43 +08:00
README.md Neither latexmk nor dvipng is required 2021-08-18 20:43:51 +08:00

README.md

The Linux Kernel Module Programming Guide

This project keeps the Linux Kernel Module Programming Guide reasonably 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

Compile on Local Machine

To prepare for build this book on your local machine, we're going to install TeXLive (MacTeX). On various Unix/Linux operating systems, this can be done simply by:

# 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

Now we could build document with following commands:

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

# run commands
$ make all              # Generate PDFdocument
$ make html             # Convert TeX to HTML
$ make clean            # Delete generated files

Compile with Docker

The compilation could be completed flawlessly using Docker. **Using Docker is recommended, as it guarantees the same dependencies with our GitHub Actions wokrflow.

After install docker engine on your machine, pulling the docker image twtug/lkmpg and compile with it.

Execute followings

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

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

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