You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-25Lines changed: 27 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,31 @@
1
1
# The Linux Kernel Module Programming Guide
2
2
3
-
This project keeps the Linux Kernel Module Programming Guide reasonably up to date, with [working examples](examples/) for recent 5.x kernel versions.
3
+
This project keeps the Linux Kernel Module Programming Guide up to date, with [working examples](examples/) for recent 5.x kernel versions.
4
4
The guide has been around since 2001 and most copies of it on the web only describe old 2.6.x kernels.
5
5
6
6
The book can be freely accessed via https://sysprog21.github.io/lkmpg/ or [latest PDF file](https://github.com/sysprog21/lkmpg/releases).
7
7
The original guide may be found at [Linux Documentation Project](http://www.tldp.org/LDP/lkmpg/).
8
8
9
9
## Getting Started
10
10
11
-
### Compile on Local Machine
11
+
### Summary
12
+
1. Get the latest source code from the [GitHub page](https://github.com/sysprog21/lkmpg).
13
+
2. Install the prerequisites.
14
+
3. Generate PDF and/or HTML documents.
12
15
13
-
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:
16
+
### Step 1: Get the latest source code
17
+
18
+
Make sure you can run `git` with an Internet connection.
Alternatively, using [Docker](https://docs.docker.com/) is recommended, as it guarantees the same dependencies with our GitHub Actions wokrflow.
43
+
After install [docker engine](https://docs.docker.com/engine/install/) on your machine, pull the docker image [twtug/lkmpg](https://hub.docker.com/r/twtug/lkmpg) and run in isolated containers.
32
44
33
-
# run commands
34
-
$ make all # Generate PDFdocument
35
-
$ make html # Convert TeX to HTML
36
-
$ make clean # Delete generated files
45
+
```shell
46
+
# pull docker image and run it as container
47
+
$ docker pull twtug/lkmpg
48
+
$ docker run --rm -it -v $(pwd):/workdir twtug/lkmpg
37
49
```
38
50
39
-
### Compile with Docker
40
-
41
-
The compilation could be completed flawlessly using Docker. **Using Docker is recommended, as it guarantees the same dependencies with our GitHub Actions wokrflow.
51
+
[nerdctl](https://github.com/containerd/nerdctl) is a Docker-compatible command line tool for [containerd](https://containerd.io/), and you can replace the above `docker` commands with `nerdctl` counterparts.
42
52
43
-
After [install docker engine](https://docs.docker.com/engine/install/) on your machine, pulling the docker image [twtug/lkmpg](https://hub.docker.com/r/twtug/lkmpg) and compile with it.
53
+
### Step 3: Generate PDF and/or HTML documents
44
54
45
-
Execute followings
55
+
Now we could build document with following commands:
0 commit comments