lkmpg/.gitignore

# Linux kernel build system
*.o
*.ko
*cmd
*.dwo
*.swp
*.symvers
*.mod
*.mod.c
modules.order

# LaTeX
_minted-lkmpg
*.aux
*.log
*.out
lkmpg.pdf
*.toc
*.bbl
*.blg

# make4ht
*.html
*.svg 
*.tmp
*.css 
*.4ct 
*.4tc 
*.dvi 
*.lg 
*.idv
*.xref

# format checks
expected-format
Exclude the files generated by Linux kernel build system 2021-07-22 08:09:20 +08:00			`# Linux kernel build system`
Add LaTeX script and sample code 2021-07-22 06:35:24 +08:00			`*.o`
			`*.ko`
			`*cmd`
Update several example code for newer kernel Known issues with current example code: If you using newer kernel(e.g linux 5.11.x) to compile the example code, you may meet following error: 1. syscall.c:83:50: error: ‘ksys_close’ undeclared; 2. cryptosk.c:17:24: error: field ‘sg’ has incomplete type 3. cryptosk.c:143:9: error: implicit declaration of function ‘get_random_bytes’ 4. error: macro "DECLARE_TASKLET" passed 3 arguments, but takes just 2 Solutions/workaround: 1. In syscall.c, replace #include <linux/syscalls.h> with #include <linux/fdtable.h> and replace ksys_close with close_fd if the kernel version >= 5.11. [1][2] 2. Add #include <linux/scatterlist.h> into cryptosk.c 3. Add #include <linux/random.h> into cryptosk.c 4. In bottomhalf.c and example_tasklet.c, replace DECLARE_TASKLET with DECLARE_TASKLET_OLD and dispose third argument(0L). [3] [1] - https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1572bfdf21d4d50e51941498ffe0b56c2289f783 [2] - https://www.mail-archive.com/meta-arago@arago-project.org//msg11939.html [3] - https://patchwork.kernel.org/project/kernel-hardening/patch/20200716030847.1564131-3-keescook@chromium.org/ 2021-08-23 21:30:43 +08:00			`*.dwo`
Add LaTeX script and sample code 2021-07-22 06:35:24 +08:00			`*.swp`
			`*.symvers`
Exclude the files generated by Linux kernel build system 2021-07-22 08:09:20 +08:00			`*.mod`
			`*.mod.c`
			`modules.order`
Add LaTeX script and sample code 2021-07-22 06:35:24 +08:00
			`# LaTeX`
			`_minted-lkmpg`
			`*.aux`
			`*.log`
			`*.out`
			`lkmpg.pdf`
			`*.toc`
Update .gitignore 2021-08-09 20:23:12 +08:00			`*.bbl`
			`*.blg`
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". 2021-08-02 02:42:39 +08:00
			`# make4ht`
			`*.html`
			`*.svg`
			`*.tmp`
			`*.css`
			`*.4ct`
			`*.4tc`
			`*.dvi`
			`*.lg`
			`*.idv`
			`*.xref`
Check coding style in CI 2021-08-17 13:07:06 +08:00
			`# format checks`
Update several example code for newer kernel Known issues with current example code: If you using newer kernel(e.g linux 5.11.x) to compile the example code, you may meet following error: 1. syscall.c:83:50: error: ‘ksys_close’ undeclared; 2. cryptosk.c:17:24: error: field ‘sg’ has incomplete type 3. cryptosk.c:143:9: error: implicit declaration of function ‘get_random_bytes’ 4. error: macro "DECLARE_TASKLET" passed 3 arguments, but takes just 2 Solutions/workaround: 1. In syscall.c, replace #include <linux/syscalls.h> with #include <linux/fdtable.h> and replace ksys_close with close_fd if the kernel version >= 5.11. [1][2] 2. Add #include <linux/scatterlist.h> into cryptosk.c 3. Add #include <linux/random.h> into cryptosk.c 4. In bottomhalf.c and example_tasklet.c, replace DECLARE_TASKLET with DECLARE_TASKLET_OLD and dispose third argument(0L). [3] [1] - https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=1572bfdf21d4d50e51941498ffe0b56c2289f783 [2] - https://www.mail-archive.com/meta-arago@arago-project.org//msg11939.html [3] - https://patchwork.kernel.org/project/kernel-hardening/patch/20200716030847.1564131-3-keescook@chromium.org/ 2021-08-23 21:30:43 +08:00			`expected-format`