Commit Graph

78 Commits

Author SHA1 Message Date
fennecj
99faf5ed0f Fix typo 2021-08-16 23:48:04 +08:00
Jim Huang
4acc65b740 Use \verb for the identifiers starting with "--" 2021-08-16 21:21:10 +08:00
Chih-Yu Chen
c8238430b2
Avoid incorrectly separated words (#55)
This patch fixed some typos and added the missing punctuation.
2021-08-16 18:45:43 +08:00
fennecj
15e44bffa8 Fix grammar and typo 2021-08-16 00:47:23 +08:00
Jim Huang
964f14dda6 Annotate more directories/files 2021-08-13 01:02:21 +08:00
fennecj
990358d75a Fix typo 2021-08-13 00:52:33 +08:00
fennecj
b656755300 Fix typo 2021-08-11 18:34:23 +08:00
Jim Huang
8d7caa7fc9 Make insmod/rmmod more consistent 2021-08-11 15:08:08 +08:00
fennecj
e87998c224 Fix incorrect path
There should be a space between uname and -r
2021-08-10 18:22:33 +08:00
Jim Huang
6b6083fca2 Remove out-of-date information 2021-08-09 23:59:59 +08:00
Jim Huang
b002e43bb8 Annotate NULL 2021-08-09 23:57:30 +08:00
Jim Huang
e800505b8f Point to corresponding kernel header 2021-08-09 23:26:01 +08:00
Jim Huang
a4c44ed3d1 Annotate more commands 2021-08-09 23:23:08 +08:00
Jim Huang
2d368210ce Introduce \src to generate Linux kernel source hyperlinks
The new command \src was introduced for preliminary hyperlink generation
which points to Linux kernel source code. At present, stable/linux.git
was referred:
  https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git

We might switch to specific LTS kernels once requested.
2021-08-09 23:01:34 +08:00
Jim Huang
da3dd34cd2 Revise the path of Linux kernel headers
This patch uses the relative path to Linux kernel headers in source tree
rather than what they are usually inclused in LKM. It would be great to
introduce \href with appropriate hyperlinks to Linux kernel tree.
2021-08-09 22:37:20 +08:00
Jim Huang
e551c98dde Clarify kernel header inclusion
Both <linux/module.h> and <linux/kernel.h> are essential headers, and
LKM should include them. Here, we do not use the fully qualified path
specifying the headers.
2021-08-09 22:05:08 +08:00
Jim Huang
251adeb075 Change the header file which defines sys_delete_module 2021-08-09 22:00:57 +08:00
Jim Huang
526ad3c842 Annotate function calls 2021-08-09 21:41:50 +08:00
Jim Huang
53ef0614e8 Annotate more commands 2021-08-09 21:35:19 +08:00
Jim Huang
971148e3ed Annotate 'mknod' command 2021-08-09 21:19:40 +08:00
Jim Huang
2ac8a81945 Add hyperlinks to microkernel examples 2021-08-09 21:17:22 +08:00
Jim Huang
5786975d89 Update tLDP hyperlink 2021-08-09 21:12:04 +08:00
Jim Huang
bb3466461a Add hyperlink to Understanding The Linux Kernel 2021-08-09 21:11:15 +08:00
Jim Huang
e0ad741c8c Fix layout with \LaTeX 2021-08-09 21:07:35 +08:00
Jim Huang
3208d46d46 Always mention \LaTeX rather than plain text form 2021-08-09 20:53:50 +08:00
Jim Huang
fe0ad50e6f Fix cross reference 2021-08-09 20:51:12 +08:00
Jim Huang
ebfe5404c0 Use the newer entries for Linux kernel documentation 2021-08-09 20:40:09 +08:00
Jim Huang
1b487e5931 Annotate the path 2021-08-09 20:35:24 +08:00
Jim Huang
91418dec73 Remove out-of-date kernel source descriptions 2021-08-09 20:31:03 +08:00
Jim Huang
375bdd0ccf Unify the annotations
This patch enforces the annotations by means of the following:
  * \cpp : C/C++ code, functions, variables, macros, symbols
  * \sh : commands, executable files
  * \verb : path and filenames
2021-08-09 20:20:38 +08:00
VxTeemo
d1c0efeec9
fix minor typo
verb warp wrong at line 330 "linux/.config"
2021-08-09 17:21:56 +08:00
Arush Sharma
51d96f56e5
fix minor typo
Fixes a very minor typo.
2021-08-08 02:23:07 +05:30
Jim Huang
d0721da3d9 Tidy the rest of chapters 2021-08-07 18:35:28 +08:00
Jim Huang
2303d5c851 Tidy section: Optimizations 2021-08-07 11:02:49 +08:00
Jim Huang
40e83aa14b Tidy section: The Device Model 2021-08-07 10:59:15 +08:00
Jim Huang
939bd4e9ab Tidy section: Crypto 2021-08-07 10:56:16 +08:00
Jim Huang
e1d31e9500 Tidy section: Interrupt Handlers 2021-08-07 10:35:52 +08:00
Jim Huang
768b70e95e Tidy section: Scheduling Tasks 2021-08-07 10:27:05 +08:00
Jim Huang
2c1f4d185b Tidy section: Replacing Print Macros
FIXME: we should rewrite this section
2021-08-07 10:24:08 +08:00
Jim Huang
4a34cc69b3 Tidy section: Avoiding Collisions and Deadlocks 2021-08-07 10:16:08 +08:00
Jim Huang
678757e19c Tidy section: Blocking Processes and threads 2021-08-07 10:07:22 +08:00
Jim Huang
3070689d19 Update document maintainer information 2021-08-07 09:52:03 +08:00
asas1asas200
92b646ed64
proc_ops: Be aware of kernel API changes (#13)
The proc_ops structure is defined in <include/linux/proc_fs.h> since
Linux v5.6+.
In older kernels, file_operations structure is used for custom hooks in
/proc file system. However, it contains some members that are unnecessary
in VFS, and every time VFS expands file_operations set, /proc code comes
bloated.

On the other hand, not only the space, but also some operations were
saved by this structure to improve its performance.
2021-08-06 18:08:05 +08:00
Jim Huang
466e8a00fd cat_nonblock: Use canonical name scheme and fix unintended assignment 2021-08-05 14:28:12 +08:00
吳建興
634c3659a8
Fix typo. 2021-08-05 02:16:36 +08:00
RinHizakura
5940dd9faa
Revise hello-5 and its output (#38)
For the example module hello_5, the book showed the incorrect output
in corresponding with its execution results.

In addition, this patch changes from myintArray[2] = {-1, -1} to
myintArray[2] = {420, 420}, which help the readers distinguish from
the kernel messages.
2021-08-04 23:42:10 +08:00
吳建興
a7f81a2cfc
Fix typo.
There is a typo in chapter 0.6.3.
2021-08-04 09:33:21 +08:00
Jim Huang
7c129a4276 Minor wording tweak 2021-08-03 06:29:52 +08:00
demonsome
45769753d3
procfs1: Fix parameter descriptions (#34)
In "procfs1.c," the "buffer" is actually the second parameter of procfile_read().
The "offset" is the fourth one.
2021-08-02 23:01:34 +08:00
demonsome
65a8f5a1d6
Unify device node name "/proc/helloworld" (#33)
The file name "proc helloworld" was not consistent with that of the later
sentences. The latter sentences use the device node name "/proc/helloworld".
2021-08-02 22:59:19 +08:00