| kernel-docs.rst (d053cf0d771f6547cb0537759a9af63cf402908d) | kernel-docs.rst (e7b4311ebcac142be28c9fa1b9f63a9d35fc2a92) |
|---|---|
| 1.. _kernel_docs: 2 3Index of Documentation for People Interested in Writing and/or Understanding the Linux Kernel 4============================================================================================= 5 6 Juan-Mariano de Goyeneche <jmseyas@dit.upm.es> 7 8The need for a document like this one became apparent in the --- 84 unchanged lines hidden (view full) --- 93 there are and how likley they get merged. 94 :Abstract: 95 [...]. This paper examines some common problems for 96 submitting larger changes and some strategies to avoid problems. 97 98 * Title: **Linux Device Drivers, Third Edition** 99 100 :Author: Jonathan Corbet, Alessandro Rubini, Greg Kroah-Hartman | 1.. _kernel_docs: 2 3Index of Documentation for People Interested in Writing and/or Understanding the Linux Kernel 4============================================================================================= 5 6 Juan-Mariano de Goyeneche <jmseyas@dit.upm.es> 7 8The need for a document like this one became apparent in the --- 84 unchanged lines hidden (view full) --- 93 there are and how likley they get merged. 94 :Abstract: 95 [...]. This paper examines some common problems for 96 submitting larger changes and some strategies to avoid problems. 97 98 * Title: **Linux Device Drivers, Third Edition** 99 100 :Author: Jonathan Corbet, Alessandro Rubini, Greg Kroah-Hartman |
| 101 :URL: http://lwn.net/Kernel/LDD3/ | 101 :URL: https://lwn.net/Kernel/LDD3/ |
| 102 :Date: 2005 103 :Description: A 600-page book covering the (2.6.10) driver 104 programming API and kernel hacking in general. Available under the 105 Creative Commons Attribution-ShareAlike 2.0 license. 106 :note: You can also :ref:`purchase a copy from O'Reilly or elsewhere <ldd3_published>`. 107 108 * Title: **Writing an ALSA Driver** 109 --- 14 unchanged lines hidden (view full) --- 124 :Description: "This document describes how to write kernel device 125 drivers for the Linux PCMCIA Card Services interface. It also 126 describes how to write user-mode utilities for communicating with 127 Card Services. 128 129 * Title: **Linux Kernel Module Programming Guide** 130 131 :Author: Ori Pomerantz. | 102 :Date: 2005 103 :Description: A 600-page book covering the (2.6.10) driver 104 programming API and kernel hacking in general. Available under the 105 Creative Commons Attribution-ShareAlike 2.0 license. 106 :note: You can also :ref:`purchase a copy from O'Reilly or elsewhere <ldd3_published>`. 107 108 * Title: **Writing an ALSA Driver** 109 --- 14 unchanged lines hidden (view full) --- 124 :Description: "This document describes how to write kernel device 125 drivers for the Linux PCMCIA Card Services interface. It also 126 describes how to write user-mode utilities for communicating with 127 Card Services. 128 129 * Title: **Linux Kernel Module Programming Guide** 130 131 :Author: Ori Pomerantz. |
| 132 :URL: http://tldp.org/LDP/lkmpg/2.6/html/index.html | 132 :URL: https://tldp.org/LDP/lkmpg/2.6/html/index.html |
| 133 :Date: 2001 134 :Keywords: modules, GPL book, /proc, ioctls, system calls, 135 interrupt handlers . 136 :Description: Very nice 92 pages GPL book on the topic of modules 137 programming. Lots of examples. 138 139 * Title: **Global spinlock list and usage** 140 --- 98 unchanged lines hidden (view full) --- 239 :URL: http://www.linux-mag.com/id/381 240 :Date: 1999 241 :Keywords: video4linux, driver, radio, radio devices. 242 :Description: The title says it all. 243 244 * Title: **I/O Event Handling Under Linux** 245 246 :Author: Richard Gooch. | 133 :Date: 2001 134 :Keywords: modules, GPL book, /proc, ioctls, system calls, 135 interrupt handlers . 136 :Description: Very nice 92 pages GPL book on the topic of modules 137 programming. Lots of examples. 138 139 * Title: **Global spinlock list and usage** 140 --- 98 unchanged lines hidden (view full) --- 239 :URL: http://www.linux-mag.com/id/381 240 :Date: 1999 241 :Keywords: video4linux, driver, radio, radio devices. 242 :Description: The title says it all. 243 244 * Title: **I/O Event Handling Under Linux** 245 246 :Author: Richard Gooch. |
| 247 :URL: http://web.mit.edu/~yandros/doc/io-events.html | 247 :URL: https://web.mit.edu/~yandros/doc/io-events.html |
| 248 :Date: 1999 249 :Keywords: IO, I/O, select(2), poll(2), FDs, aio_read(2), readiness 250 event queues. 251 :Description: From the Introduction: "I/O Event handling is about 252 how your Operating System allows you to manage a large number of 253 open files (file descriptors in UNIX/POSIX, or FDs) in your 254 application. You want the OS to notify you when FDs become active 255 (have data ready to be read or are ready for writing). Ideally you --- 34 unchanged lines hidden (view full) --- 290 Venus and kernel level file system code needed for the operation 291 of the Coda filesystem. This version document is meant to describe 292 the current interface (version 1.0) as well as improvements we 293 envisage". 294 295 * Title: **Design and Implementation of the Second Extended Filesystem** 296 297 :Author: Rémy Card, Theodore Ts'o, Stephen Tweedie. | 248 :Date: 1999 249 :Keywords: IO, I/O, select(2), poll(2), FDs, aio_read(2), readiness 250 event queues. 251 :Description: From the Introduction: "I/O Event handling is about 252 how your Operating System allows you to manage a large number of 253 open files (file descriptors in UNIX/POSIX, or FDs) in your 254 application. You want the OS to notify you when FDs become active 255 (have data ready to be read or are ready for writing). Ideally you --- 34 unchanged lines hidden (view full) --- 290 Venus and kernel level file system code needed for the operation 291 of the Coda filesystem. This version document is meant to describe 292 the current interface (version 1.0) as well as improvements we 293 envisage". 294 295 * Title: **Design and Implementation of the Second Extended Filesystem** 296 297 :Author: Rémy Card, Theodore Ts'o, Stephen Tweedie. |
| 298 :URL: http://web.mit.edu/tytso/www/linux/ext2intro.html | 298 :URL: https://web.mit.edu/tytso/www/linux/ext2intro.html |
| 299 :Date: 1998 300 :Keywords: ext2, linux fs history, inode, directory, link, devices, 301 VFS, physical structure, performance, benchmarks, ext2fs library, 302 ext2fs tools, e2fsck. 303 :Description: Paper written by three of the top ext2 hackers. 304 Covers Linux filesystems history, ext2 motivation, ext2 features, 305 design, physical structure on disk, performance, benchmarks, 306 e2fsck's passes description... A must read! --- 10 unchanged lines hidden (view full) --- 317 :Abstract: *A description of the implementation of the RAID-1, 318 RAID-4 and RAID-5 personalities of the MD device driver in the 319 Linux kernel, providing users with high performance and reliable, 320 secondary-storage capability using software*. 321 322 * Title: **Linux Kernel Hackers' Guide** 323 324 :Author: Michael K. Johnson. | 299 :Date: 1998 300 :Keywords: ext2, linux fs history, inode, directory, link, devices, 301 VFS, physical structure, performance, benchmarks, ext2fs library, 302 ext2fs tools, e2fsck. 303 :Description: Paper written by three of the top ext2 hackers. 304 Covers Linux filesystems history, ext2 motivation, ext2 features, 305 design, physical structure on disk, performance, benchmarks, 306 e2fsck's passes description... A must read! --- 10 unchanged lines hidden (view full) --- 317 :Abstract: *A description of the implementation of the RAID-1, 318 RAID-4 and RAID-5 personalities of the MD device driver in the 319 Linux kernel, providing users with high performance and reliable, 320 secondary-storage capability using software*. 321 322 * Title: **Linux Kernel Hackers' Guide** 323 324 :Author: Michael K. Johnson. |
| 325 :URL: http://www.tldp.org/LDP/khg/HyperNews/get/khg.html | 325 :URL: https://www.tldp.org/LDP/khg/HyperNews/get/khg.html |
| 326 :Date: 1997 327 :Keywords: device drivers, files, VFS, kernel interface, character vs 328 block devices, hardware interrupts, scsi, DMA, access to user memory, 329 memory allocation, timers. 330 :Description: A guide designed to help you get up to speed on the 331 concepts that are not intuitevly obvious, and to document the internal 332 structures of Linux. 333 --- 36 unchanged lines hidden (view full) --- 370 :Description: Linux Journal Kernel Korner article. 371 :Abstract: *This article, the third of four on writing character 372 device drivers, introduces concepts of reading, writing, and using 373 ioctl-calls*. 374 375 * Title: **Dissecting Interrupts and Browsing DMA** 376 377 :Author: Alessandro Rubini and Georg v. Zezschwitz. | 326 :Date: 1997 327 :Keywords: device drivers, files, VFS, kernel interface, character vs 328 block devices, hardware interrupts, scsi, DMA, access to user memory, 329 memory allocation, timers. 330 :Description: A guide designed to help you get up to speed on the 331 concepts that are not intuitevly obvious, and to document the internal 332 structures of Linux. 333 --- 36 unchanged lines hidden (view full) --- 370 :Description: Linux Journal Kernel Korner article. 371 :Abstract: *This article, the third of four on writing character 372 device drivers, introduces concepts of reading, writing, and using 373 ioctl-calls*. 374 375 * Title: **Dissecting Interrupts and Browsing DMA** 376 377 :Author: Alessandro Rubini and Georg v. Zezschwitz. |
| 378 :URL: http://www.linuxjournal.com/article.php?sid=1222 | 378 :URL: https://www.linuxjournal.com/article.php?sid=1222 |
| 379 :Date: 1996 380 :Keywords: interrupts, irqs, DMA, bottom halves, task queues. 381 :Description: Linux Journal Kernel Korner article. 382 :Abstract: *This is the fourth in a series of articles about 383 writing character device drivers as loadable kernel modules. This 384 month, we further investigate the field of interrupt handling. 385 Though it is conceptually simple, practical limitations and 386 constraints make this an ''interesting'' part of device driver 387 writing, and several different facilities have been provided for 388 different situations. We also investigate the complex topic of 389 DMA*. 390 391 * Title: **Device Drivers Concluded** 392 393 :Author: Georg v. Zezschwitz. | 379 :Date: 1996 380 :Keywords: interrupts, irqs, DMA, bottom halves, task queues. 381 :Description: Linux Journal Kernel Korner article. 382 :Abstract: *This is the fourth in a series of articles about 383 writing character device drivers as loadable kernel modules. This 384 month, we further investigate the field of interrupt handling. 385 Though it is conceptually simple, practical limitations and 386 constraints make this an ''interesting'' part of device driver 387 writing, and several different facilities have been provided for 388 different situations. We also investigate the complex topic of 389 DMA*. 390 391 * Title: **Device Drivers Concluded** 392 393 :Author: Georg v. Zezschwitz. |
| 394 :URL: http://www.linuxjournal.com/article.php?sid=1287 | 394 :URL: https://www.linuxjournal.com/article.php?sid=1287 |
| 395 :Date: 1996 396 :Keywords: address spaces, pages, pagination, page management, 397 demand loading, swapping, memory protection, memory mapping, mmap, 398 virtual memory areas (VMAs), vremap, PCI. 399 :Description: Finally, the above turned out into a five articles 400 series. This latest one's introduction reads: "This is the last of 401 five articles about character device drivers. In this final 402 section, Georg deals with memory mapping devices, beginning with 403 an overall description of the Linux memory management concepts". 404 405 * Title: **Network Buffers And Memory Management** 406 407 :Author: Alan Cox. | 395 :Date: 1996 396 :Keywords: address spaces, pages, pagination, page management, 397 demand loading, swapping, memory protection, memory mapping, mmap, 398 virtual memory areas (VMAs), vremap, PCI. 399 :Description: Finally, the above turned out into a five articles 400 series. This latest one's introduction reads: "This is the last of 401 five articles about character device drivers. In this final 402 section, Georg deals with memory mapping devices, beginning with 403 an overall description of the Linux memory management concepts". 404 405 * Title: **Network Buffers And Memory Management** 406 407 :Author: Alan Cox. |
| 408 :URL: http://www.linuxjournal.com/article.php?sid=1312 | 408 :URL: https://www.linuxjournal.com/article.php?sid=1312 |
| 409 :Date: 1996 410 :Keywords: sk_buffs, network devices, protocol/link layer 411 variables, network devices flags, transmit, receive, 412 configuration, multicast. 413 :Description: Linux Journal Kernel Korner. 414 :Abstract: *Writing a network device driver for Linux is fundamentally 415 simple---most of the complexity (other than talking to the 416 hardware) involves managing network packets in memory*. 417 418 * Title: **Analysis of the Ext2fs structure** 419 420 :Author: Louis-Dominique Dubeau. | 409 :Date: 1996 410 :Keywords: sk_buffs, network devices, protocol/link layer 411 variables, network devices flags, transmit, receive, 412 configuration, multicast. 413 :Description: Linux Journal Kernel Korner. 414 :Abstract: *Writing a network device driver for Linux is fundamentally 415 simple---most of the complexity (other than talking to the 416 hardware) involves managing network packets in memory*. 417 418 * Title: **Analysis of the Ext2fs structure** 419 420 :Author: Louis-Dominique Dubeau. |
| 421 :URL: http://teaching.csse.uwa.edu.au/units/CITS2002/fs-ext2/ | 421 :URL: https://teaching.csse.uwa.edu.au/units/CITS2002/fs-ext2/ |
| 422 :Date: 1994 423 :Keywords: ext2, filesystem, ext2fs. 424 :Description: Description of ext2's blocks, directories, inodes, 425 bitmaps, invariants... 426 427Published books 428--------------- 429 --- 45 unchanged lines hidden (view full) --- 475 476 :Authors: Jonathan Corbet, Alessandro Rubini, and Greg Kroah-Hartman 477 :Publisher: O'Reilly & Associates 478 :Date: 2005 479 :Pages: 636 480 :ISBN: 0-596-00590-3 481 :Notes: Further information in 482 http://www.oreilly.com/catalog/linuxdrive3/ | 422 :Date: 1994 423 :Keywords: ext2, filesystem, ext2fs. 424 :Description: Description of ext2's blocks, directories, inodes, 425 bitmaps, invariants... 426 427Published books 428--------------- 429 --- 45 unchanged lines hidden (view full) --- 475 476 :Authors: Jonathan Corbet, Alessandro Rubini, and Greg Kroah-Hartman 477 :Publisher: O'Reilly & Associates 478 :Date: 2005 479 :Pages: 636 480 :ISBN: 0-596-00590-3 481 :Notes: Further information in 482 http://www.oreilly.com/catalog/linuxdrive3/ |
| 483 PDF format, URL: http://lwn.net/Kernel/LDD3/ | 483 PDF format, URL: https://lwn.net/Kernel/LDD3/ |
| 484 485 * Title: **Linux Kernel Internals** 486 487 :Author: Michael Beck 488 :Publisher: Addison-Wesley 489 :Date: 1997 490 :ISBN: 0-201-33143-8 (second edition) 491 --- 64 unchanged lines hidden (view full) --- 556 :URL: https://elixir.bootlin.com/ 557 :Keywords: Browsing source code. 558 :Description: Another web-based Linux kernel source code browser. 559 Lots of cross references to variables and functions. You can see 560 where they are defined and where they are used. 561 562 * Name: **Linux Weekly News** 563 | 484 485 * Title: **Linux Kernel Internals** 486 487 :Author: Michael Beck 488 :Publisher: Addison-Wesley 489 :Date: 1997 490 :ISBN: 0-201-33143-8 (second edition) 491 --- 64 unchanged lines hidden (view full) --- 556 :URL: https://elixir.bootlin.com/ 557 :Keywords: Browsing source code. 558 :Description: Another web-based Linux kernel source code browser. 559 Lots of cross references to variables and functions. You can see 560 where they are defined and where they are used. 561 562 * Name: **Linux Weekly News** 563 |
| 564 :URL: http://lwn.net | 564 :URL: https://lwn.net |
| 565 :Keywords: latest kernel news. 566 :Description: The title says it all. There's a fixed kernel section 567 summarizing developers' work, bug fixes, new features and versions 568 produced during the week. Published every Thursday. 569 570 * Name: **The home page of Linux-MM** 571 572 :Author: The Linux-MM team. | 565 :Keywords: latest kernel news. 566 :Description: The title says it all. There's a fixed kernel section 567 summarizing developers' work, bug fixes, new features and versions 568 produced during the week. Published every Thursday. 569 570 * Name: **The home page of Linux-MM** 571 572 :Author: The Linux-MM team. |
| 573 :URL: http://linux-mm.org/ | 573 :URL: https://linux-mm.org/ |
| 574 :Keywords: memory management, Linux-MM, mm patches, TODO, docs, 575 mailing list. 576 :Description: Site devoted to Linux Memory Management development. 577 Memory related patches, HOWTOs, links, mm developers... Don't miss 578 it if you are interested in memory management development! 579 580 * Name: **Kernel Newbies IRC Channel and Website** 581 | 574 :Keywords: memory management, Linux-MM, mm patches, TODO, docs, 575 mailing list. 576 :Description: Site devoted to Linux Memory Management development. 577 Memory related patches, HOWTOs, links, mm developers... Don't miss 578 it if you are interested in memory management development! 579 580 * Name: **Kernel Newbies IRC Channel and Website** 581 |
| 582 :URL: http://www.kernelnewbies.org | 582 :URL: https://www.kernelnewbies.org |
| 583 :Keywords: IRC, newbies, channel, asking doubts. 584 :Description: #kernelnewbies on irc.oftc.net. 585 #kernelnewbies is an IRC network dedicated to the 'newbie' 586 kernel hacker. The audience mostly consists of people who are 587 learning about the kernel, working on kernel projects or 588 professional kernel hackers that want to help less seasoned kernel 589 people. 590 #kernelnewbies is on the OFTC IRC Network. --- 9 unchanged lines hidden (view full) --- 600 :Description: Some of the linux-kernel mailing list archivers. If 601 you have a better/another one, please let me know. 602 603------- 604 605Document last updated on Tue 2016-Sep-20 606 607This document is based on: | 583 :Keywords: IRC, newbies, channel, asking doubts. 584 :Description: #kernelnewbies on irc.oftc.net. 585 #kernelnewbies is an IRC network dedicated to the 'newbie' 586 kernel hacker. The audience mostly consists of people who are 587 learning about the kernel, working on kernel projects or 588 professional kernel hackers that want to help less seasoned kernel 589 people. 590 #kernelnewbies is on the OFTC IRC Network. --- 9 unchanged lines hidden (view full) --- 600 :Description: Some of the linux-kernel mailing list archivers. If 601 you have a better/another one, please let me know. 602 603------- 604 605Document last updated on Tue 2016-Sep-20 606 607This document is based on: |
| 608 http://www.dit.upm.es/~jmseyas/linux/kernel/hackers-docs.html | 608 https://www.dit.upm.es/~jmseyas/linux/kernel/hackers-docs.html |