2021-08-19 03:17:28

by Henry Tseng

[permalink] [raw]
Subject: [PATCH v2] Documentation: Update details of The Linux Kernel Module Programming Guide

Recently, the content and examples of the book "The Linux Kernel Module
Programming Guide" are being actively maintained and added on Github[1].
Currently, the book is being regularly built into webpage and pdf
file using Github static page[2].

[1]: https://github.com/sysprog21/lkmpg
[2]: https://sysprog21.github.io/lkmpg/

Signed-off-by: Chun-Hung Tseng <[email protected]>
---
Documentation/process/kernel-docs.rst | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kernel-docs.rst
index 22d9ace5df2a..631a3dc04e3e 100644
--- a/Documentation/process/kernel-docs.rst
+++ b/Documentation/process/kernel-docs.rst
@@ -126,15 +126,17 @@ On-line docs
describes how to write user-mode utilities for communicating with
Card Services.

- * Title: **Linux Kernel Module Programming Guide**
+ * Title: **The Linux Kernel Module Programming Guide**

- :Author: Ori Pomerantz.
- :URL: https://tldp.org/LDP/lkmpg/2.6/html/index.html
- :Date: 2001
+ :Author: Peter Jay Salzman, Michael Burian, Ori Pomerantz, Bob Mottram,
+ Jim Huang.
+ :URL: https://sysprog21.github.io/lkmpg/
+ :Date: 2021
:Keywords: modules, GPL book, /proc, ioctls, system calls,
interrupt handlers .
- :Description: Very nice 92 pages GPL book on the topic of modules
- programming. Lots of examples.
+ :Description: A very nice 93 pages GPL book on the topic of modules
+ programming. Lots of examples. Currently the new version is being
+ actively maintained at https://github.com/sysprog21/lkmpg.

* Title: **Global spinlock list and usage**

--
2.25.1


2021-08-19 03:31:09

by Henry Tseng

[permalink] [raw]
Subject: Re: [PATCH v2] Documentation: Update details of The Linux Kernel Module Programming Guide

As a side note, I tried to put Juan-Mariano de Goyeneche
<[email protected]> in cc, as indicated on the kernel-docs file. But
the email account is not reachable.

On Thu, Aug 19, 2021 at 5:16 AM Chun-Hung Tseng <[email protected]> wrote:
>
> Recently, the content and examples of the book "The Linux Kernel Module
> Programming Guide" are being actively maintained and added on Github[1].
> Currently, the book is being regularly built into webpage and pdf
> file using Github static page[2].
>
> [1]: https://github.com/sysprog21/lkmpg
> [2]: https://sysprog21.github.io/lkmpg/
>
> Signed-off-by: Chun-Hung Tseng <[email protected]>
> ---
> Documentation/process/kernel-docs.rst | 14 ++++++++------
> 1 file changed, 8 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kernel-docs.rst
> index 22d9ace5df2a..631a3dc04e3e 100644
> --- a/Documentation/process/kernel-docs.rst
> +++ b/Documentation/process/kernel-docs.rst
> @@ -126,15 +126,17 @@ On-line docs
> describes how to write user-mode utilities for communicating with
> Card Services.
>
> - * Title: **Linux Kernel Module Programming Guide**
> + * Title: **The Linux Kernel Module Programming Guide**
>
> - :Author: Ori Pomerantz.
> - :URL: https://tldp.org/LDP/lkmpg/2.6/html/index.html
> - :Date: 2001
> + :Author: Peter Jay Salzman, Michael Burian, Ori Pomerantz, Bob Mottram,
> + Jim Huang.
> + :URL: https://sysprog21.github.io/lkmpg/
> + :Date: 2021
> :Keywords: modules, GPL book, /proc, ioctls, system calls,
> interrupt handlers .
> - :Description: Very nice 92 pages GPL book on the topic of modules
> - programming. Lots of examples.
> + :Description: A very nice 93 pages GPL book on the topic of modules
> + programming. Lots of examples. Currently the new version is being
> + actively maintained at https://github.com/sysprog21/lkmpg.
>
> * Title: **Global spinlock list and usage**
>
> --
> 2.25.1
>


--
Best wishes,
Henry

2021-08-20 17:20:20

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH v2] Documentation: Update details of The Linux Kernel Module Programming Guide

Chun-Hung Tseng <[email protected]> writes:

> Recently, the content and examples of the book "The Linux Kernel Module
> Programming Guide" are being actively maintained and added on Github[1].
> Currently, the book is being regularly built into webpage and pdf
> file using Github static page[2].
>
> [1]: https://github.com/sysprog21/lkmpg
> [2]: https://sysprog21.github.io/lkmpg/
>
> Signed-off-by: Chun-Hung Tseng <[email protected]>
> ---
> Documentation/process/kernel-docs.rst | 14 ++++++++------
> 1 file changed, 8 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kernel-docs.rst
> index 22d9ace5df2a..631a3dc04e3e 100644
> --- a/Documentation/process/kernel-docs.rst
> +++ b/Documentation/process/kernel-docs.rst
> @@ -126,15 +126,17 @@ On-line docs
> describes how to write user-mode utilities for communicating with
> Card Services.
>
> - * Title: **Linux Kernel Module Programming Guide**
> + * Title: **The Linux Kernel Module Programming Guide**
>
> - :Author: Ori Pomerantz.
> - :URL: https://tldp.org/LDP/lkmpg/2.6/html/index.html
> - :Date: 2001
> + :Author: Peter Jay Salzman, Michael Burian, Ori Pomerantz, Bob Mottram,
> + Jim Huang.
> + :URL: https://sysprog21.github.io/lkmpg/
> + :Date: 2021
> :Keywords: modules, GPL book, /proc, ioctls, system calls,
> interrupt handlers .
> - :Description: Very nice 92 pages GPL book on the topic of modules
> - programming. Lots of examples.
> + :Description: A very nice 93 pages GPL book on the topic of modules
> + programming. Lots of examples. Currently the new version is being
> + actively maintained at https://github.com/sysprog21/lkmpg.

If this book is now being consistently maintained, then the number of
pages is sure to change in short order; it seems like kind of a strange
thing to track here...?

Thanks,

jon

2021-08-20 22:27:00

by Henry Tseng

[permalink] [raw]
Subject: Re: [PATCH v2] Documentation: Update details of The Linux Kernel Module Programming Guide

On Fri, Aug 20, 2021 at 7:17 PM Jonathan Corbet <[email protected]> wrote:
>
> Chun-Hung Tseng <[email protected]> writes:
>
> > Recently, the content and examples of the book "The Linux Kernel Module
> > Programming Guide" are being actively maintained and added on Github[1].
> > Currently, the book is being regularly built into webpage and pdf
> > file using Github static page[2].
> >
> > [1]: https://github.com/sysprog21/lkmpg
> > [2]: https://sysprog21.github.io/lkmpg/
> >
> > Signed-off-by: Chun-Hung Tseng <[email protected]>
> > ---
> > Documentation/process/kernel-docs.rst | 14 ++++++++------
> > 1 file changed, 8 insertions(+), 6 deletions(-)
> >
> > diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kernel-docs.rst
> > index 22d9ace5df2a..631a3dc04e3e 100644
> > --- a/Documentation/process/kernel-docs.rst
> > +++ b/Documentation/process/kernel-docs.rst
> > @@ -126,15 +126,17 @@ On-line docs
> > describes how to write user-mode utilities for communicating with
> > Card Services.
> >
> > - * Title: **Linux Kernel Module Programming Guide**
> > + * Title: **The Linux Kernel Module Programming Guide**
> >
> > - :Author: Ori Pomerantz.
> > - :URL: https://tldp.org/LDP/lkmpg/2.6/html/index.html
> > - :Date: 2001
> > + :Author: Peter Jay Salzman, Michael Burian, Ori Pomerantz, Bob Mottram,
> > + Jim Huang.
> > + :URL: https://sysprog21.github.io/lkmpg/
> > + :Date: 2021
> > :Keywords: modules, GPL book, /proc, ioctls, system calls,
> > interrupt handlers .
> > - :Description: Very nice 92 pages GPL book on the topic of modules
> > - programming. Lots of examples.
> > + :Description: A very nice 93 pages GPL book on the topic of modules
> > + programming. Lots of examples. Currently the new version is being
> > + actively maintained at https://github.com/sysprog21/lkmpg.
>
> If this book is now being consistently maintained, then the number of
> pages is sure to change in short order; it seems like kind of a strange
> thing to track here...?
>
> Thanks,
>
> jon


Sorry about it.

v3 has been pushed, dropping the term "93 pages".

Thank you for the feedback!

Henry