Documentation/process/kernel-docs.rst

   1 .. _kernel_docs:
   2
   3 Index of Further Kernel Documentation
   4 =====================================
   5
   6 The need for a document like this one became apparent in the
   7 linux-kernel mailing list as the same questions, asking for pointers
   8 to information, appeared again and again.
   9
  10 Fortunately, as more and more people get to GNU/Linux, more and more
  11 get interested in the Kernel. But reading the sources is not always
  12 enough. It is easy to understand the code, but miss the concepts, the
  13 philosophy and design decisions behind this code.
  14
  15 Unfortunately, not many documents are available for beginners to
  16 start. And, even if they exist, there was no "well-known" place which
  17 kept track of them. These lines try to cover this lack.
  18
  19 PLEASE, if you know any paper not listed here or write a new document,
  20 include a reference to it here, following the kernel's patch submission
  21 process. Any corrections, ideas or comments are also welcome.
  22
  23 All documents are cataloged with the following fields: the document's
  24 "Title", the "Author"/s, the "URL" where they can be found, some
  25 "Keywords" helpful when searching for specific topics, and a brief
  26 "Description" of the Document.
  27
  28 .. note::
  29
  30    The documents on each section of this document are ordered by its
  31    published date, from the newest to the oldest. The maintainer(s) should
  32    periodically retire resources as they become obsolte or outdated; with
  33    the exception of foundational books.
  34
  35 Docs at the Linux Kernel tree
  36 -----------------------------
  37
  38 The 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 document
  47         (including this document itself) have been moved there, and might
  48         be more up to date than the web version.
  49
  50 On-line docs
  51 ------------
  52
  53     * Title: **Linux Kernel Mailing List Glossary**
  54
  55       :Author: various
  56       :URL: https://kernelnewbies.org/KernelGlossary
  57       :Date: rolling version
  58       :Keywords: glossary, terms, linux-kernel.
  59       :Description: From the introduction: "This glossary is intended as
  60         a brief description of some of the acronyms and terms you may hear
  61         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: 2021
  69       :Keywords: modules, GPL book, /proc, ioctls, system calls,
  70         interrupt handlers .
  71       :Description: A very nice GPL book on the topic of modules
  72         programming. Lots of examples. Currently the new version is being
  73         actively maintained at https://github.com/sysprog21/lkmpg.
  74
  75 Published books
  76 ---------------
  77
  78     * Title: **Linux Kernel Debugging: Leverage proven tools and advanced techniques to effectively debug Linux kernels and kernel modules**
  79
  80       :Author: Kaiwan N Billimoria
  81       :Publisher: Packt Publishing Ltd
  82       :Date: August, 2022
  83       :Pages: 638
  84       :ISBN: 978-1801075039
  85       :Notes: Debugging book
  86
  87     * Title: **Linux Kernel Programming: A Comprehensive Guide to Kernel Internals, Writing Kernel Modules, and Kernel Synchronization**
  88
  89       :Author: Kaiwan N Billimoria
  90       :Publisher: Packt Publishing Ltd
  91       :Date: March, 2021
  92       :Pages: 754
  93       :ISBN: 978-1789953435
  94
  95     * 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**
  96
  97       :Author: Kaiwan N Billimoria
  98       :Publisher: Packt Publishing Ltd
  99       :Date: March, 2021
 100       :Pages: 452
 101       :ISBN: 978-1801079518
 102
 103     * Title: **Linux System Programming: Talking Directly to the Kernel and C Library**
 104
 105       :Author: Robert Love
 106       :Publisher: O'Reilly Media
 107       :Date: June, 2013
 108       :Pages: 456
 109       :ISBN: 978-1449339531
 110       :Notes: Foundational book
 111
 112     * Title: **Linux Kernel Development, 3rd Edition**
 113
 114       :Author: Robert Love
 115       :Publisher: Addison-Wesley
 116       :Date: July, 2010
 117       :Pages: 440
 118       :ISBN: 978-0672329463
 119       :Notes: Foundational book
 120
 121 .. _ldd3_published:
 122
 123     * Title: **Linux Device Drivers, 3rd Edition**
 124
 125       :Authors: Jonathan Corbet, Alessandro Rubini, and Greg Kroah-Hartman
 126       :Publisher: O'Reilly & Associates
 127       :Date: 2005
 128       :Pages: 636
 129       :ISBN: 0-596-00590-3
 130       :Notes: Foundational book. Further information in
 131         http://www.oreilly.com/catalog/linuxdrive3/
 132         PDF format, URL: https://lwn.net/Kernel/LDD3/
 133
 134     * Title: **The Design of the UNIX Operating System**
 135
 136       :Author: Maurice J. Bach
 137       :Publisher: Prentice Hall
 138       :Date: 1986
 139       :Pages: 471
 140       :ISBN: 0-13-201757-1
 141       :Notes: Foundational book
 142
 143 Miscellaneous
 144 -------------
 145
 146     * Name: **Cross-Referencing Linux**
 147
 148       :URL: https://elixir.bootlin.com/
 149       :Keywords: Browsing source code.
 150       :Description: Another web-based Linux kernel source code browser.
 151         Lots of cross references to variables and functions. You can see
 152         where they are defined and where they are used.
 153
 154     * Name: **Linux Weekly News**
 155
 156       :URL: https://lwn.net
 157       :Keywords: latest kernel news.
 158       :Description: The title says it all. There's a fixed kernel section
 159         summarizing developers' work, bug fixes, new features and versions
 160         produced during the week.
 161
 162     * Name: **The home page of Linux-MM**
 163
 164       :Author: The Linux-MM team.
 165       :URL: https://linux-mm.org/
 166       :Keywords: memory management, Linux-MM, mm patches, TODO, docs,
 167         mailing list.
 168       :Description: Site devoted to Linux Memory Management development.
 169         Memory related patches, HOWTOs, links, mm developers... Don't miss
 170         it if you are interested in memory management development!
 171
 172     * Name: **Kernel Newbies IRC Channel and Website**
 173
 174       :URL: https://www.kernelnewbies.org
 175       :Keywords: IRC, newbies, channel, asking doubts.
 176       :Description: #kernelnewbies on irc.oftc.net.
 177         #kernelnewbies is an IRC network dedicated to the 'newbie'
 178         kernel hacker. The audience mostly consists of people who are
 179         learning about the kernel, working on kernel projects or
 180         professional kernel hackers that want to help less seasoned kernel
 181         people.
 182         #kernelnewbies is on the OFTC IRC Network.
 183         Try irc.oftc.net as your server and then /join #kernelnewbies.
 184         The kernelnewbies website also hosts articles, documents, FAQs...
 185
 186     * Name: **linux-kernel mailing list archives and search engines**
 187
 188       :URL: http://vger.kernel.org/vger-lists.html
 189       :URL: http://www.uwsg.indiana.edu/hypermail/linux/kernel/index.html
 190       :URL: http://groups.google.com/group/mlist.linux.kernel
 191       :Keywords: linux-kernel, archives, search.
 192       :Description: Some of the linux-kernel mailing list archivers. If
 193         you have a better/another one, please let me know.
 194
 195 -------
 196
 197 This document was originally based on:
 198
 199  https://www.dit.upm.es/~jmseyas/linux/kernel/hackers-docs.html
 200
 201 and written by Juan-Mariano de Goyeneche