Re: [PATCH 0/3] Improve Kernel documentation guide

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Em Tue, 22 Nov 2016 10:09:53 +0100
Markus Heiser <markus.heiser@xxxxxxxxxxx> escreveu:

> Am 22.11.2016 um 09:44 schrieb Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>:
> 
> > Em Mon, 21 Nov 2016 08:48:00 +0100
> > Markus Heiser <markus.heiser@xxxxxxxxxxx> escreveu:
> >   
> >> Am 19.11.2016 um 19:22 schrieb Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>:  
> >>> 
> >>> And, a more detailed description using --man. Right now --man
> >>> displays an identical content of the part below that comment
> >>> in the rst file, because I used pad2rst for the conversion.    
> >> 
> >> Sorry, IMO this is conceptual wrong.
> >> 
> >> reST is the base format from which we create other output formats.
> >> Even if we have no man page generation from reST yet, we should not
> >> promote toolchains using language specific markups (POD) as base
> >> format.  
> > 
> > Sorry but I don't agree with you here ;)  
> 
> I'am very happy with your last commit: "to be in the mid term " ;-)

OK, great!

> >> So it might be time to investigate some efforts in a 'man'-page 
> >> target. Ask me if I can help.  
> > 
> > Generating man pages is something that we need to do anyway.
> > It would be great if you could restart such work.  
> 
> Its on the way, but before I need to clarify conceptual
> how to merge the builder into the kernel sources.

What do you mean?

> A preview of the work is available at:
> 
>   https://h2626237.stratoserver.net/kernel/docs.html
> 
> follow the 'man' links in the parenthesis.
> 
> The man page builder source is available here:
> 
>   https://github.com/return42/linuxdoc/blob/master/linuxdoc/manKernelDoc.py

Looks good... yet, it misses the media docs...

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



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux