Documentation: Update details of The Linux Kernel Module Programming Guide
PATCH v3 1/1 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/
--- Documentation/process/kernel-docs.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)
Documentation/process/kernel-docs.rst +8 -6
@@ -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 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**
Signature · 1 line
2.25.1
Quoted 28 lines · Chun-Hung Tseng
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(-)Documentation/process/kernel-docs.rst +2
-4@@ -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,
Documentation/process/kernel-docs.rst On-line docs · line 139
Quoted 10 lines
Documentation/process/kernel-docs.rst +6
-2+ 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 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.
I have applied this, thanks.
That said, this change introduced a set of build warnings:
Documentation/process/kernel-docs.rst:132: WARNING: Field list ends without a blank line; unexpected unindent. Documentation/process/kernel-docs.rst:136: WARNING: Unexpected indentation. Documentation/process/kernel-docs.rst:137: WARNING: Block quote ends without a blank line; unexpected unindent.
To fix that, I had to do this:
Documentation/process/kernel-docs.rst +1 -1
@@ -129,7 +129,7 @@ On-line docs * Title: **The Linux Kernel Module Programming Guide** :Author: Peter Jay Salzman, Michael Burian, Ori Pomerantz, Bob Mottram, - Jim Huang. + Jim Huang. :URL: https://sysprog21.github.io/lkmpg/ :Date: 2021 :Keywords: modules, GPL book, /proc, ioctls, system calls,
Please, be sure to test the docs build before sending patches.
Thanks,
jon
Quoted 74 lines · Jonathan Corbet
Quoted 40 lines · Chun-Hung Tseng
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(-)Documentation/process/kernel-docs.rst +0
-0@@ -126,15 +126,17 @@ On-line docs describes how to write user-mode utilities for communicatingwith
Card Services.Documentation/process/kernel-docs.rst +2
-4- * 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, BobMottram,
Documentation/process/kernel-docs.rst +5
-2+ 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 GPL book on the topic of modules + programming. Lots of examples. Currently the new version isQuoted 2 lines
being
+ actively maintained at https://github.com/sysprog21/lkmpg.I have applied this, thanks.
That said, this change introduced a set of build warnings:
Documentation/process/kernel-docs.rst:132: WARNING: Field list ends
without a blank line; unexpected unindent.
Documentation/process/kernel-docs.rst:136: WARNING: Unexpected
indentation.
Documentation/process/kernel-docs.rst:137: WARNING: Block quote ends
without a blank line; unexpected unindent.To fix that, I had to do this:
Documentation/process/kernel-docs.rst +1
-1@@ -129,7 +129,7 @@ On-line docs * Title: **The Linux Kernel Module Programming Guide** :Author: Peter Jay Salzman, Michael Burian, Ori Pomerantz, Bob Mottram, - Jim Huang. + Jim Huang. :URL: https://sysprog21.github.io/lkmpg/ :Date: 2021:Keywords: modules, GPL book, /proc, ioctls, system calls,
Quoted 6 lines
Please, be sure to test the docs build before sending patches.
Thanks,
jon
Hi Jon,
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 in the last few email exchanges.
Should we probably amend that part of the file, too?
Thank you!
Signature · 2 lines
Best wishes, Henry
Quoted 74 lines · Jonathan Corbet
Quoted 40 lines · Chun-Hung Tseng
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(-)Documentation/process/kernel-docs.rst +0
-0@@ -126,15 +126,17 @@ On-line docs describes how to write user-mode utilities for communicatingwith
Card Services.Documentation/process/kernel-docs.rst +2
-4- * 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, BobMottram,
Documentation/process/kernel-docs.rst +5
-2+ 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 GPL book on the topic of modules + programming. Lots of examples. Currently the new version isQuoted 2 lines
being
+ actively maintained at https://github.com/sysprog21/lkmpg.I have applied this, thanks.
That said, this change introduced a set of build warnings:
Documentation/process/kernel-docs.rst:132: WARNING: Field list ends
without a blank line; unexpected unindent.
Documentation/process/kernel-docs.rst:136: WARNING: Unexpected
indentation.
Documentation/process/kernel-docs.rst:137: WARNING: Block quote ends
without a blank line; unexpected unindent.To fix that, I had to do this:
Documentation/process/kernel-docs.rst +1
-1@@ -129,7 +129,7 @@ On-line docs * Title: **The Linux Kernel Module Programming Guide** :Author: Peter Jay Salzman, Michael Burian, Ori Pomerantz, Bob Mottram, - Jim Huang. + Jim Huang. :URL: https://sysprog21.github.io/lkmpg/ :Date: 2021:Keywords: modules, GPL book, /proc, ioctls, system calls,
Quoted 2 lines
Please, be sure to test the docs build before sending patches.
Hi Jon,
Thank you for applying the patch and giving me feedback!
I will be more careful in the future.
Thank you!
Best wishes,
Henry
Quoted 4 lines
Thanks,
jon