docs: kernel-docs: add a reference mentioned in submitting-drivers.rst
authorLukas Bulwahn <lukas.bulwahn@gmail.com>
Mon, 4 Jul 2022 12:25:30 +0000 (14:25 +0200)
committerJonathan Corbet <corbet@lwn.net>
Thu, 14 Jul 2022 21:03:56 +0000 (15:03 -0600)
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>
Documentation/process/kernel-docs.rst

index b2523267ffc7f0fd9e3fc7d3c9f76d144119d63b..502289d6338565f4f8425dcbbf24f46c32f0d042 100644 (file)
@@ -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.