All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>,
	Federico Vaga <federico.vaga@vaga.pv.it>,
	Alex Shi <alexs@kernel.org>, Yanteng Si <siyanteng@loongson.cn>,
	Hu Haowen <src.res@email.cn>,
	linux-doc@vger.kernel.org,
	linux-doc-tw-discuss@lists.sourceforge.net
Cc: Jean Delvare <jdelvare@suse.com>,
	Guenter Roeck <linux@roeck-us.net>,
	linux-hwmon@vger.kernel.org, kernel-janitors@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: [RFC PATCH 04/11] docs: kernel-docs: add a reference mentioned in submitting-drivers.rst
Date: Mon, 27 Jun 2022 17:18:12 +0200	[thread overview]
Message-ID: <20220627151819.22694-5-lukas.bulwahn@gmail.com> (raw)
In-Reply-To: <20220627151819.22694-1-lukas.bulwahn@gmail.com>

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>
---
 Documentation/process/kernel-docs.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

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.
-- 
2.17.1


  parent reply	other threads:[~2022-06-27 15:19 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-27 15:18 [RFC PATCH 00/11] docs: remove submitting-drivers.rst Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 01/11] docs: kernel-docs: order reference from newest to oldest Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 02/11] docs: kernel-docs: shorten the lengthy doc title Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 03/11] docs: kernel-docs: reflect that it is community-maintained Lukas Bulwahn
2022-06-27 15:18 ` Lukas Bulwahn [this message]
2022-06-27 15:18 ` [RFC PATCH 05/11] docs: admin: devices: drop confusing outdated statement on Latex Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 06/11] docs: process: remove outdated submitting-drivers.rst Lukas Bulwahn
2022-06-28  1:20   ` Bagas Sanjaya
2022-06-28  5:00     ` Lukas Bulwahn
2022-06-28  6:40       ` Bagas Sanjaya
2022-06-27 15:18 ` [RFC PATCH 07/11] docs: it_IT: align to submitting-drivers removal Lukas Bulwahn
2022-06-28  9:16   ` Federico Vaga
2022-06-28 10:27     ` Lukas Bulwahn
2022-07-04  9:49     ` Lukas Bulwahn
2022-07-04 10:59       ` Federico Vaga
2022-06-27 15:18 ` [RFC PATCH 08/11] docs: ja_JP: howto: remove reference to removed submitting-drivers Lukas Bulwahn
2022-06-28  5:25   ` Akira Yokosawa
2022-06-28 10:24     ` Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 09/11] docs: ko_KR: " Lukas Bulwahn
2022-06-27 15:18 ` [RFC PATCH 10/11] docs: zh_CN: align to submitting-drivers removal Lukas Bulwahn
2022-06-29  6:40   ` Alex Shi
2022-06-27 15:18 ` [RFC PATCH 11/11] docs: zh_TW: " Lukas Bulwahn
2022-06-28  2:50 ` [RFC PATCH 00/11] docs: remove submitting-drivers.rst Bagas Sanjaya
2022-06-28  4:52   ` Lukas Bulwahn
2022-06-30 17:26 ` Jonathan Corbet
2022-07-04 13:02   ` Lukas Bulwahn

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220627151819.22694-5-lukas.bulwahn@gmail.com \
    --to=lukas.bulwahn@gmail.com \
    --cc=alexs@kernel.org \
    --cc=corbet@lwn.net \
    --cc=federico.vaga@vaga.pv.it \
    --cc=jdelvare@suse.com \
    --cc=kernel-janitors@vger.kernel.org \
    --cc=linux-doc-tw-discuss@lists.sourceforge.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=siyanteng@loongson.cn \
    --cc=src.res@email.cn \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.