Fix typo: concurent -> concurrent

Merge pull request #54 from fennecJ/patch

Fix typo

Fix typo

Make insmod/rmmod more consistent

Merge pull request #53 from fennecJ/patch

Fix incorrect path

Fix incorrect path

There should be a space between uname and -r

Merge pull request #51 from ChinYikMing/fix-init-mesg

Fix init message

Fix init message

Remove out-of-date information

Annotate NULL

Fix wording

Point to corresponding kernel header

Annotate more commands

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.

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.

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.

Change the header file which defines sys_delete_module

Annotate function calls

Annotate more commands

Annotate 'mknod' command

Add hyperlinks to microkernel examples

Update tLDP hyperlink

Add hyperlink to Understanding The Linux Kernel

Fix layout with \LaTeX

Always mention \LaTeX rather than plain text form

Fix cross reference

Use the newer entries for Linux kernel documentation

Annotate the path

Remove out-of-date kernel source descriptions

Update .gitignore

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

Merge pull request #49 from henrybear327/latex/add_very_style_inline_code

Add \cpp and \sh syntax for inline code

Add inline code blocks by using newmintinline

We can now use \cpp|...| and \sh|...| to add inline code blocks, which
resembles the \verb|...| syntax

Signed-off-by: Chun-Hung Tseng <henrybear327@gmail.com>

Merge pull request #50 from VxTeemo/patch-1

Fix minor typo

fix minor typo

verb warp wrong at line 330 "linux/.config"

Merge pull request #48 from fennecJ/patch

Temporary fix release action failed issue

Temporary fix release action failed issue

Merge pull request #47 from fennecJ/patch

Remove _minted-lkmpg directory after compiled pdf

Remove _minted-lkmpg directory after compiled pdf

The _minted-lkmpg directory should be removed AFTER all compile work is
done.

Merge pull request #46 from arushsharma24/patch-1

Fix typo

fix minor typo

Fixes a very minor typo.

Make program style consistent again

Fix alignment problem in code block (#45)

In rendered HTML, the line number should be right aligned, and
code should be left aligned accordingly.

In addition, this patch added the basic build instructions, so that
someone can generated the PDF and HTML files.

Close #44

Apply editorial changes

This patch makes source listing shorter and more compact, that helps
when browsing.

Drop the deprecated init_module() and cleanup_module()

Enforce consistent style

Execute "make indent" before submitting patches.

Mention the availability of PDF pre-release

Tweak pdfLaTeX related commands

Tidy the rest of chapters

Shorten chardev

Tidy section: Optimizations

Tidy section: The Device Model

Tidy section: Crypto

procfs4: Shorten and indent

Tidy section: Interrupt Handlers

Tidy section: Scheduling Tasks

Tidy section: Replacing Print Macros

FIXME: we should rewrite this section

Tidy section: Avoiding Collisions and Deadlocks

Tidy section: Blocking Processes and threads

Update document maintainer information

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.

Merge pull request #43 from dancek/master

Rewrite CSS to support scaling

Rewrite CSS to support scaling

This changes the layout to use the default font size with a reasonable
max width and margins around the body. Elements that would overflow on
narrow displays are changed to wrap (.author) or present a scroll bar as
necessary (figure, .verbatim, .fancyvrb). The properties on html and
body are set such that there is no full-document vertical scrolling.
Inline math is displayed in the same size as the surrounding text.

cat_nonblock: Use canonical name scheme and fix unintended assignment

Merge pull request #39 from fdgkhdkgh/master

Fix typo

Fix typo.

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.

Merge pull request #37 from fdgkhdkgh/master

Fix typo

Fix typo.

There is a typo in chapter 0.6.3.

Minor wording tweak

procfs1: Fix parameter descriptions (#34)

In "procfs1.c," the "buffer" is actually the second parameter of procfile_read().
The "offset" is the fourth one.

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

Mention the online publication

Merge pull request #32 from focaaby/master

Publish GitHub Pages with GitHub Actions

Publish GitHub Page with GitHub Action

Add a new Github Action to publish to the GitHub page. Use twtug/lkmpg
image for reproducibility.

Ref:
- sysprog21#27
- https://github.com/TeXtw/docker-lkmpg

Tidy section: system calls

Tidy section: device files

Generate HTML via make4ht (#20)

This patch generates HTML files with "make4ht" in the "html" directory.

Known issues with "make4ht":
Running "make4ht -suf html5 -d html lkmpg.tex" will cause the following
flaws:
1. The layout was unsatisfying.
2. After parsing TeX, it stoped at "\tableofcontents" with errors.
3. Several unneeded files were generated.
4. No way to specify the destination filename for HTML generation.

Solutions/workaround:
1. Use customized configuration file "html.cfg" to specify the layout style.
2. Turn off the \tableofcontents section when using make4ht. However, this
    results in the lack of table of contents in HTML. It can be fixed by
    appending "\Configure{tableofcontents*}{chapter,section,subsection}"
    to configuration file.
3. The build system removes the temporary files.
4. Use a symbolic link "index.html" to "lkmpg.html".

Add package xparse (#31)

The package xparse should be included since
\NewDocumentCommand is part of it

Remove out-of-date versioing scheme

Merge pull request #29 from ekangmonyet/master

Delete existing release asset before releasing

Delete existing release asset before releasing

Use mknejp/delete-release-assets to delete existing asset.
This approach might not be optimal if softprops/action-gh-release
supports upserting [1].

[1] https://github.com/softprops/action-gh-release/pull/134

Dockerized PDF deployment in GitHub Actions (#28)

Add a new GitHub Action to build and release the PDF file after every
push to master.  Use texlive/texlive docker image for the sake of
reproducibility in preparation for future build tools like make4ht .

Progress #27 - Reproducible TeX build environment using Docker

Tidy section: Character Device drivers

Tidy section: Preliminaries

Zircon kernel was formerly called Magenta

The renaming appeared in 2017.

Merge pull request #24 from fennecJ/patch

Fix grammar

Fix grammar

chardev: Revise comment on device node (#23)

The device file create in this example is "chardev".
So input command "sudo cat /dev/chardev" will get a valid message
"I already told you %d times Hello world!"

Fix dead link (#21)

Add information for contributing

Merge pull request #19 from fennecJ/master

Fix typo

Fix typo

Avoid strlen by assigning explicit length of string for proc_read (#18)

Since the address of buffer is userspace address, it may trigger an unexpected fault on strlen(buffer).

On Ubuntu 20.04.2 LTS ( 5.8.0-63-generic ), using strlen(buffer) will result in the following:
[ 2168.010930] /proc/buffer1k created
[ 2177.014347] BUG: unable to handle page fault for address: 00007fbbc2a17000
[ 2177.014355] #PF: supervisor read access in kernel mode
[ 2177.014358] #PF: error_code(0x0000) - not-present page
[ 2177.014361] PGD 80000003c61d0067 P4D 80000003c61d0067 PUD 3ee6c5067 PMD 40e1ff067 PTE 0
[ 2177.014369] Oops: 0000 [#1] SMP PTI
[ 2177.014376] CPU: 7 PID: 4750 Comm: cat Tainted: P        W  OE     5.8.0-63-generic #71~20.04.1-Ubuntu

[ 2177.014387] RIP: 0010:procfile_read+0xb/0x20 [procfs2]
[ 2177.014393] Code: Unable to access opcode bytes at RIP 0xffffffffc1253fe1.
[ 2177.014396] RSP: 0018:ffffbc84412cbe78 EFLAGS: 00010286
[ 2177.014400] RAX: ffffffffc1254000 RBX: 0000000000020000 RCX: ffffbc84412cbef0
[ 2177.014403] RDX: 0000000000020000 RSI: 00007fbbc2a17000 RDI: ffffa057d2708f00
[ 2177.014406] RBP: ffffbc84412cbe80 R08: 0000000000000001 R09: 0000000000000000
[ 2177.014409] R10: 0000000000000000 R11: 0000000000000000 R12: ffffa0581de8ccc0
[ 2177.014411] R13: ffffa057d2708f00 R14: ffffbc84412cbef0 R15: 00007fbbc2a17000
[ 2177.014415] FS:  00007fbbc3bfa580(0000) GS:ffffa0582dbc0000(0000) knlGS:0000000000000000
[ 2177.014418] CS:  0010 DS: 0000 ES: 0000 CR0: 0000000080050033
[ 2177.014421] CR2: ffffffffc1253fe1 CR3: 00000003c611c004 CR4: 00000000003606e0
[ 2177.014424] Call Trace:
[ 2177.014435]  proc_reg_read+0x66/0x90
[ 2177.014441]  vfs_read+0xaa/0x190
[ 2177.014446]  ksys_read+0x67/0xe0
[ 2177.014451]  __x64_sys_read+0x1a/0x20
[ 2177.014458]  do_syscall_64+0x49/0xc0
[ 2177.014464]  entry_SYSCALL_64_after_hwframe+0x44/0xa9
[ 2177.014467] RIP: 0033:0x7fbbc3b18142
[ 2177.014472] Code: c0 e9 c2 fe ff ff 50 48 8d 3d 3a ca 0a 00 e8 f5 19 02 00 0f 1f 44 00 00 f3 0f 1e fa 64 8b 04 25 18 00 00 00 85 c0 75 10 0f 05 <48> 3d 00 f0 ff ff 77 56 c3 0f 1f 44 00 00 48 83 ec 28 48 89 54 24
[ 2177.014476] RSP: 002b:00007ffcf2d20d78 EFLAGS: 00000246 ORIG_RAX: 0000000000000000
[ 2177.014479] RAX: ffffffffffffffda RBX: 0000000000020000 RCX: 00007fbbc3b18142
[ 2177.014482] RDX: 0000000000020000 RSI: 00007fbbc2a17000 RDI: 0000000000000003
[ 2177.014485] RBP: 00007fbbc2a17000 R08: 00007fbbc2a16010 R09: 0000000000000000
[ 2177.014487] R10: 0000000000000022 R11: 0000000000000246 R12: 0000560f8ff081f0
[ 2177.014490] R13: 0000000000000003 R14: 0000000000020000 R15: 0000000000020000

[ 2177.014635] CR2: 00007fbbc2a17000
[ 2177.014639] ---[ end trace b71ff05c1b0a10f6 ]---
[ 2177.184174] RIP: 0010:procfile_read+0xb/0x20 [procfs2]
[ 2177.184176] Code: Unable to access opcode bytes at RIP 0xffffffffc1253fe1.
[ 2177.184177] RSP: 0018:ffffbc84412cbe78 EFLAGS: 00010286
[ 2177.184178] RAX: ffffffffc1254000 RBX: 0000000000020000 RCX: ffffbc84412cbef0
[ 2177.184179] RDX: 0000000000020000 RSI: 00007fbbc2a17000 RDI: ffffa057d2708f00
[ 2177.184180] RBP: ffffbc84412cbe80 R08: 0000000000000001 R09: 0000000000000000
[ 2177.184180] R10: 0000000000000000 R11: 0000000000000000 R12: ffffa0581de8ccc0
[ 2177.184181] R13: ffffa057d2708f00 R14: ffffbc84412cbef0 R15: 00007fbbc2a17000
[ 2177.184182] FS:  00007fbbc3bfa580(0000) GS:ffffa0582dbc0000(0000) knlGS:0000000000000000
[ 2177.184182] CS:  0010 DS: 0000 ES: 0000 CR0: 0000000080050033
[ 2177.184183] CR2: ffffffffc1253fe1 CR3: 00000003c611c004 CR4: 00000000003606e0

Open Software License is not popular. Explicitly refer to OSI

Use unified command prompt (#11)

This patch enforces the assumption of using as a non-root user. That is,
it is necessary to specify sudo for the essential commands such as
insmod and rmmod. In addition, most command prompts should start with
$ (dollar sign).

Merge pull request #12 from 25077667/style-tweaks

Fix trivial tweak for missing comma

Fix trivial tweak for missing comma

Tidy section: hello world

Trivial fix for writing style