5

I am taking an operating system course that requires making modifications to the Linux kernel. I would like to be able to view concise information on functions like proc_create, macros like __init , data types like struct proc_dir_entry and so on, as contained in headers like linux/module.h.

Is there a man page-like format that documents them as such? I am aware the source code is available online, but I'm hoping for a easy, readable way to gather information as I develop from the command line. I've been reading LKMPG, and while helpful, it is not concise. I use Emacs, so any suggestions from within Emacs will be well-taken.

I am running ArchLinux on a VM.

Improve this question
5
  • No, I don't think there is. There are textbooks with annotated Linux source code. Commented Apr 9, 2023 at 2:48
  • You can create it yourself by running scripts/kernel-doc -man .... Commented Apr 11, 2023 at 11:11
  • Could you please specify more options @0andriy ? Commented Apr 14, 2023 at 3:03
  • scripts/kernel-doc -man include/linux/module.h > module.h.man && man --local-file module.h.man works for me. Result: module_init(9) Kernel Hacker's Manual module_init(9) NAME module_init - driver initialization entry point and so on... Commented Apr 16, 2023 at 20:15
  • Also see unix.stackexchange.com/a/148433/105842. Commented Apr 16, 2023 at 20:23
Related questions
3495
How do I make git use the editor of my choice for editing commit messages?
2847
How to change the output color of echo in Linux
1920
How do I prompt for Yes/No/Cancel input in a Linux shell script?

0

Reset to default

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.