2016-03-31 11:10:38

by Luis de Bethencourt

[permalink] [raw]
Subject: [PATCH v2 2/5] Documentation: update Michael K. Johnson's work

The URL for "Writing Linux Device Drivers" hasn't been available in some
time. Updating the entry to Michael K. Johnson's "Linux Kernel Hackers'
Guide"

Signed-off-by: Luis de Bethencourt <[email protected]>
---
Hi,

I agree with Jon that changing the URL to a different work of the same author
isn't the best idea.

The three options we have IMHO are:
- replace the entry with KHG (the patch below)
- remove the entry altogether if the KHG is not interesting to be listed
- leave "Writing Linux Device Drivers" as is with the broken URL so people
can try to find the document elsewhere. I didn't manage to find it.

Thanks,
Luis

Documentation/kernel-docs.txt | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/kernel-docs.txt b/Documentation/kernel-docs.txt
index fe217c1..b3af71e 100644
--- a/Documentation/kernel-docs.txt
+++ b/Documentation/kernel-docs.txt
@@ -194,15 +194,15 @@
simple---most of the complexity (other than talking to the
hardware) involves managing network packets in memory".

- * Title: "Writing Linux Device Drivers"
+ * Title: "Linux Kernel Hackers' Guide"
Author: Michael K. Johnson.
- URL: http://users.evitech.fi/~tk/rtos/writing_linux_device_d.html
- Keywords: files, VFS, file operations, kernel interface, character
- vs block devices, I/O access, hardware interrupts, DMA, access to
- user memory, memory allocation, timers.
- Description: Introductory 50-minutes (sic) tutorial on writing
- device drivers. 12 pages written by the same author of the "Kernel
- Hackers' Guide" which give a very good overview of the topic.
+ URL: http://www.tldp.org/LDP/khg/HyperNews/get/khg.html
+ Keywords: device drivers, files, VFS, kernel interface, character vs
+ block devices, hardware interrupts, scsi, DMA, access to user memory,
+ memory allocation, timers.
+ Description: A guide designed to help you get up to speed on the
+ concepts that are not intuitevly obvious, and to document the internal
+ structures of Linux.

* Title: "The Venus kernel interface"
Author: Peter J. Braam.
--
2.5.1


2016-04-15 21:37:43

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH v2 2/5] Documentation: update Michael K. Johnson's work

On Thu, 31 Mar 2016 12:10:30 +0100
Luis de Bethencourt <[email protected]> wrote:

> The URL for "Writing Linux Device Drivers" hasn't been available in some
> time. Updating the entry to Michael K. Johnson's "Linux Kernel Hackers'
> Guide"

OK, I've applied this one to the docs tree.

Thanks,

jon