230 lines · plain
1.. _kernel_docs:2 3Index of Further Kernel Documentation4=====================================5 6The need for a document like this one became apparent in the linux-kernel7mailing list as the same questions, asking for pointers to information,8appeared again and again.9 10Fortunately, as more and more people get to GNU/Linux, more and more get11interested in the Kernel. But reading the sources is not always enough. It12is easy to understand the code, but miss the concepts, the philosophy and13design decisions behind this code.14 15Unfortunately, not many documents are available for beginners to start.16And, even if they exist, there was no "well-known" place which kept track17of them. These lines try to cover this lack.18 19PLEASE, if you know any paper not listed here or write a new document,20include a reference to it here, following the kernel's patch submission21process. Any corrections, ideas or comments are also welcome.22 23All documents are cataloged with the following fields: the document's24"Title", the "Author"/s, the "URL" where they can be found, some "Keywords"25helpful when searching for specific topics, and a brief "Description" of26the Document.27 28.. note::29 30 The documents on each section of this document are ordered by its31 published date, from the newest to the oldest. The maintainer(s) should32 periodically retire resources as they become obsolete or outdated; with33 the exception of foundational books.34 35Docs at the Linux Kernel tree36-----------------------------37 38The Sphinx books should be built with ``make {htmldocs | pdfdocs | epubdocs}``.39 40 * Name: **linux/Documentation**41 42 :Author: Many.43 :Location: Documentation/44 :Keywords: text files, Sphinx.45 :Description: Documentation that comes with the kernel sources,46 inside the Documentation directory. Some pages from this document47 (including this document itself) have been moved there, and might48 be more up to date than the web version.49 50On-line docs51------------52 53 * Title: **Linux Kernel Mailing List Glossary**54 55 :Author: various56 :URL: https://kernelnewbies.org/KernelGlossary57 :Date: rolling version58 :Keywords: glossary, terms, linux-kernel.59 :Description: From the introduction: "This glossary is intended as60 a brief description of some of the acronyms and terms you may hear61 during discussion of the Linux kernel".62 63 * Title: **The Linux Kernel Module Programming Guide**64 65 :Author: Peter Jay Salzman, Michael Burian, Ori Pomerantz, Bob Mottram,66 Jim Huang.67 :URL: https://sysprog21.github.io/lkmpg/68 :Date: 202169 :Keywords: modules, GPL book, /proc, ioctls, system calls,70 interrupt handlers .71 :Description: A very nice GPL book on the topic of modules72 programming. Lots of examples. Currently the new version is being73 actively maintained at https://github.com/sysprog21/lkmpg.74 75 * Title: **Rust for Linux**76 77 :Author: various78 :URL: https://rust-for-linux.com/79 :Date: rolling version80 :Keywords: glossary, terms, linux-kernel.81 :Description: From the website: "Rust for Linux is the project adding82 support for the Rust language to the Linux kernel. This website is83 intended as a hub of links, documentation and resources related to84 the project".85 86Published books87---------------88 89 * Title: **Practical Linux System Administration: A Guide to Installation, Configuration, and Management, 1st Edition**90 91 :Author: Kenneth Hess92 :Publisher: O'Reilly Media93 :Date: May, 202394 :Pages: 24695 :ISBN: 978-109810903596 :Notes: System administration97 98 * Title: **Linux Kernel Debugging: Leverage proven tools and advanced techniques to effectively debug Linux kernels and kernel modules**99 100 :Author: Kaiwan N Billimoria101 :Publisher: Packt Publishing Ltd102 :Date: August, 2022103 :Pages: 638104 :ISBN: 978-1801075039105 :Notes: Debugging book106 107 * Title: **Linux Kernel Programming: A Comprehensive Guide to Kernel Internals, Writing Kernel Modules, and Kernel Synchronization**108 109 :Author: Kaiwan N Billimoria110 :Publisher: Packt Publishing Ltd111 :Date: March, 2021 (Second Edition published in 2024)112 :Pages: 754113 :ISBN: 978-1789953435 (Second Edition ISBN is 978-1803232225)114 115 * Title: **Linux Kernel Programming Part 2 - Char Device Drivers and Kernel Synchronization: Create user-kernel interfaces, work with peripheral I/O, and handle hardware interrupts**116 117 :Author: Kaiwan N Billimoria118 :Publisher: Packt Publishing Ltd119 :Date: March, 2021120 :Pages: 452121 :ISBN: 978-1801079518122 123 * Title: **Linux System Programming: Talking Directly to the Kernel and C Library**124 125 :Author: Robert Love126 :Publisher: O'Reilly Media127 :Date: June, 2013128 :Pages: 456129 :ISBN: 978-1449339531130 :Notes: Foundational book131 132 * Title: **Linux Kernel Development, 3rd Edition**133 134 :Author: Robert Love135 :Publisher: Addison-Wesley136 :Date: July, 2010137 :Pages: 440138 :ISBN: 978-0672329463139 :Notes: Foundational book140 141.. _ldd3_published:142 143 * Title: **Linux Device Drivers, 3rd Edition**144 145 :Authors: Jonathan Corbet, Alessandro Rubini, and Greg Kroah-Hartman146 :Publisher: O'Reilly & Associates147 :Date: 2005148 :Pages: 636149 :ISBN: 0-596-00590-3150 :Notes: Foundational book. Further information in151 http://www.oreilly.com/catalog/linuxdrive3/152 PDF format, URL: https://lwn.net/Kernel/LDD3/153 154 * Title: **The Design of the UNIX Operating System**155 156 :Author: Maurice J. Bach157 :Publisher: Prentice Hall158 :Date: 1986159 :Pages: 471160 :ISBN: 0-13-201757-1161 :Notes: Foundational book162 163Miscellaneous164-------------165 166 * Name: **Cross-Referencing Linux**167 168 :URL: https://elixir.bootlin.com/169 :Keywords: Browsing source code.170 :Description: Another web-based Linux kernel source code browser.171 Lots of cross references to variables and functions. You can see172 where they are defined and where they are used.173 174 * Name: **Linux Weekly News**175 176 :URL: https://lwn.net177 :Keywords: latest kernel news.178 :Description: The title says it all. There's a fixed kernel section179 summarizing developers' work, bug fixes, new features and versions180 produced during the week.181 182 * Name: **The home page of Linux-MM**183 184 :Author: The Linux-MM team.185 :URL: https://linux-mm.org/186 :Keywords: memory management, Linux-MM, mm patches, TODO, docs,187 mailing list.188 :Description: Site devoted to Linux Memory Management development.189 Memory related patches, HOWTOs, links, mm developers... Don't miss190 it if you are interested in memory management development!191 192 * Name: **Kernel Newbies IRC Channel and Website**193 194 :URL: https://www.kernelnewbies.org195 :Keywords: IRC, newbies, channel, asking doubts.196 :Description: #kernelnewbies on irc.oftc.net.197 #kernelnewbies is an IRC network dedicated to the 'newbie'198 kernel hacker. The audience mostly consists of people who are199 learning about the kernel, working on kernel projects or200 professional kernel hackers that want to help less seasoned kernel201 people.202 #kernelnewbies is on the OFTC IRC Network.203 Try irc.oftc.net as your server and then /join #kernelnewbies.204 The kernelnewbies website also hosts articles, documents, FAQs...205 206 * Name: **linux-kernel mailing list archives and search engines**207 208 :URL: https://subspace.kernel.org209 :URL: https://lore.kernel.org210 :Keywords: linux-kernel, archives, search.211 :Description: Some of the linux-kernel mailing list archivers. If212 you have a better/another one, please let me know.213 214 * Name: **The Linux Foundation YouTube channel**215 216 :URL: https://www.youtube.com/user/thelinuxfoundation217 :Keywords: linux, videos, linux-foundation, youtube.218 :Description: The Linux Foundation uploads video recordings of their219 collaborative events, Linux conferences including LinuxCon, and220 other original research and content related to Linux and software221 development.222 223-------224 225This document was originally based on:226 227 https://www.dit.upm.es/~jmseyas/linux/kernel/hackers-docs.html228 229and written by Juan-Mariano de Goyeneche230