Commit 6c568f6a authored by Lukas Bulwahn's avatar Lukas Bulwahn Committed by Jonathan Corbet
Browse files

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: default avatarLukas Bulwahn <lukas.bulwahn@gmail.com>
Link: https://lore.kernel.org/r/20220704122537.3407-5-lukas.bulwahn@gmail.com


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent f46b4b16

Documentation/process/kernel-docs.rst

+14 −0
Original line number Diff line number Diff line
@@ -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.