Re: [PATCH 0/4] Update kernel-docs.rst

[Mauro Carvalho Chehab]

Em Tue, 20 Sep 2016 02:40:21 +0200
Richard Sailer  escreveu:

> I think kernel-docs.rst should be kept. (Or at least another/updated
> file fullfilling this purpose should exist) Therefore I put 
> some effort into updating it.
> 
> This patch relies on Mauros: 
>[Patch v2 ...] Create a book for Kernel development
> 
> 
> Summary
> ---
> This patch: 
> 
>  * Removes all the dead links according to Jon and Mauro in 
>https://lkml.kernel.org/r/20160916182849.2a7101ea () vento ! lan
> 
>  * Removes some very old articles covering linux 2.0 or 2.2 
>(I could have been cleaning up much more aggressive, but 
> I wanted to be carefull for the first patch. I can send a 
> further patch deleting several more IMHO outdated entries 
> if this is appreciated/wanted.)
> 
>  * Adds 4 recent books/articles, which are helpfull IMHO
> 
>  * Fixes some minor layouting and indentation issues
> 
> 
> kernel-docs.rst: Remove offline or outdated entries
> kernel-docs.rst: Improve layouting of book list
> kernel-docs.rst: Add 4 paper/book references
> kernel-docs.rst: Consistent indenting: 4 spaces

Looks good to me.

Reviewed-by: Mauro Carvalho Chehab 

I actually rebased them on my tree to apply them before the patch that
renames everything, and added on my experimental tree:

https://git.linuxtv.org//mchehab/experimental.git/log/?h=docs-next

I couldn't resist: I made my own set of patches improving it,
adding timestamps to all online documents, removing some stuff,
adding other stuff, etc ;)

I updated the documents at mchehab.fedorapeople.org to reflect the
changes:

HTML:   https://mchehab.fedorapeople.org/development-process/
LaTex:  
https://mchehab.fedorapeople.org/development-process/latex/development-process.tex
PDF:
https://mchehab.fedorapeople.org/development-process/latex/development-process.pdf
  
ePub:   
https://mchehab.fedorapeople.org/development-process/epub/LinuxKernelDevelopmentDocumentation.epub

I'll be sending such patch series in a few.

Thanks,
Mauro
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 0/4] Update kernel-docs.rst

[Mauro Carvalho Chehab]

Em Tue, 20 Sep 2016 02:40:21 +0200
Richard Sailer  escreveu:

> I think kernel-docs.rst should be kept. (Or at least another/updated
> file fullfilling this purpose should exist) Therefore I put 
> some effort into updating it.
> 
> This patch relies on Mauros: 
>[Patch v2 ...] Create a book for Kernel development
> 
> 
> Summary
> ---
> This patch: 
> 
>  * Removes all the dead links according to Jon and Mauro in 
>https://lkml.kernel.org/r/20160916182849.2a7101ea () vento ! lan
> 
>  * Removes some very old articles covering linux 2.0 or 2.2 
>(I could have been cleaning up much more aggressive, but 
> I wanted to be carefull for the first patch. I can send a 
> further patch deleting several more IMHO outdated entries 
> if this is appreciated/wanted.)
> 
>  * Adds 4 recent books/articles, which are helpfull IMHO
> 
>  * Fixes some minor layouting and indentation issues

Thanks for the patch!

Some suggestions for future work:

1) It could be useful to also take a look on the docs pointed 
as "The latest version of this document":
http://www.dit.upm.es/~jmseyas/linux/kernel/hackers-docs.html

(I would actually remove it - or keep the above URL as a reference
at the end - as clearly the Kernel version diverged from the one
on that site)

2) It would also make sense to order the entries by publication
date, placing the newer ones before the old ones.

3) I would add some newer books too. The advantage of a book is that
the main development topics are all listed altogether. I have those 
books on my bookshelf, and found them useful to me by the time I
bought them (several years ago):


https://www.amazon.com/Embedded-Linux-Primer-Practical-Real-World/dp/0137017839/ref=pd_sim_14_8?ie=UTF8=1=HQ6TJW1RKA4YSH2PH9T9
(2011)

https://www.amazon.com/Essential-Device-Drivers-Sreekrishnan-Venkateswaran/dp/0132396556/ref=pd_sim_14_10?ie=UTF8=1=TWWS52NANC39MB11A6EC
(2008)

They're now a bit old, but still newer than the ones listed on
kernel-docs.rst (except or the Robert Love's book's reference,
with was updated to point to the newest version).

Regards,
Mauro
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH 0/4] Update kernel-docs.rst

[Richard Sailer]

I think kernel-docs.rst should be kept. (Or at least another/updated
file fullfilling this purpose should exist) Therefore I put 
some effort into updating it.

This patch relies on Mauros: 
   [Patch v2 ...] Create a book for Kernel development


Summary
---
This patch: 

 * Removes all the dead links according to Jon and Mauro in 
   https://lkml.kernel.org/r/20160916182849.2a7101ea () vento ! lan

 * Removes some very old articles covering linux 2.0 or 2.2 
   (I could have been cleaning up much more aggressive, but 
I wanted to be carefull for the first patch. I can send a 
further patch deleting several more IMHO outdated entries 
if this is appreciated/wanted.)

 * Adds 4 recent books/articles, which are helpfull IMHO

 * Fixes some minor layouting and indentation issues


kernel-docs.rst: Remove offline or outdated entries
kernel-docs.rst: Improve layouting of book list
kernel-docs.rst: Add 4 paper/book references
kernel-docs.rst: Consistent indenting: 4 spaces
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html