summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLukas Bulwahn <lukas.bulwahn@gmail.com>2022-07-04 14:25:30 +0200
committerJonathan Corbet <corbet@lwn.net>2022-07-14 15:03:56 -0600
commit6c568f6a42ab77e5a299ea152efc89f38d88f334 (patch)
tree6aeb0949d7281f2351d3e54eece926f4a6715d90
parentf46b4b168cdb3b16ae8c7792c28d0b921db1932b (diff)
downloadlwn-6c568f6a42ab77e5a299ea152efc89f38d88f334.tar.gz
lwn-6c568f6a42ab77e5a299ea152efc89f38d88f334.zip
docs: kernel-docs: add a reference mentioned in submitting-drivers.rst
One section in submitting-drivers.rst was just a collection of references to other external documentation. All except the one added in this commit is already mentioned in kernel-docs or other places in the kernel documentation. Add Arjan van de Ven's article on How to NOT write kernel driver to this index of further kernel documentation. Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20220704122537.3407-5-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rw-r--r--Documentation/process/kernel-docs.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kernel-docs.rst
index b2523267ffc7..502289d63385 100644
--- a/Documentation/process/kernel-docs.rst
+++ b/Documentation/process/kernel-docs.rst
@@ -134,6 +134,20 @@ On-line docs
describes how to write user-mode utilities for communicating with
Card Services.
+ * Title: **How NOT to write kernel drivers**
+
+ :Author: Arjan van de Ven.
+ :URL: https://landley.net/kdocs/ols/2002/ols2002-pages-545-555.pdf
+ :Date: 2002
+ :Keywords: driver.
+ :Description: Programming bugs and Do-nots in kernel driver development
+ :Abstract: *Quit a few tutorials, articles and books give an introduction
+ on how to write Linux kernel drivers. Unfortunately the things one
+ should NOT do in Linux kernel code is either only a minor appendix
+ or, more commonly, completely absent. This paper tries to briefly touch
+ the areas in which the most common and serious bugs and do-nots are
+ encountered.*
+
* Title: **Global spinlock list and usage**
:Author: Rick Lindsley.