* Re: [PATCH v3] Documentation: Update details of The Linux Kernel Module Programming Guide
2021-08-20 23:06 ` Jonathan Corbet
@ 2021-08-21 13:15 ` Henry Tseng
2021-08-21 13:18 ` Henry Tseng
1 sibling, 0 replies; 4+ messages in thread
From: Henry Tseng @ 2021-08-21 13:15 UTC (permalink / raw)
To: Jonathan Corbet; +Cc: jmseyas, linux-doc, linux-kernel
On 8/21/21, Jonathan Corbet <corbet@lwn.net> wrote:
> Chun-Hung Tseng <henrybear327@gmail.com> 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 <henrybear327@gmail.com>
>> ---
>> 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..dd911cf09b55 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 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:
>
> diff --git a/Documentation/process/kernel-docs.rst
> b/Documentation/process/kernel-docs.rst
> index dd911cf09b55..da9527502ef0 100644
> --- a/Documentation/process/kernel-docs.rst
> +++ b/Documentation/process/kernel-docs.rst
> @@ -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
>
Hi Jon,
I tried to put Juan-Mariano de Goyeneche (jmseyas@dit.upm.es) 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!
--
Best wishes,
Henry
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v3] Documentation: Update details of The Linux Kernel Module Programming Guide
2021-08-20 23:06 ` Jonathan Corbet
2021-08-21 13:15 ` Henry Tseng
@ 2021-08-21 13:18 ` Henry Tseng
1 sibling, 0 replies; 4+ messages in thread
From: Henry Tseng @ 2021-08-21 13:18 UTC (permalink / raw)
To: Jonathan Corbet; +Cc: jmseyas, linux-doc, linux-kernel
On 8/21/21, Jonathan Corbet <corbet@lwn.net> wrote:
> Chun-Hung Tseng <henrybear327@gmail.com> 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 <henrybear327@gmail.com>
>> ---
>> 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..dd911cf09b55 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 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:
>
> diff --git a/Documentation/process/kernel-docs.rst
> b/Documentation/process/kernel-docs.rst
> index dd911cf09b55..da9527502ef0 100644
> --- a/Documentation/process/kernel-docs.rst
> +++ b/Documentation/process/kernel-docs.rst
> @@ -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.
>
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
> Thanks,
>
> jon
>
^ permalink raw reply [flat|nested] 4+ messages in thread