[Ksummit-discuss] [TECH TOPIC] kernel documentation

Mauro Carvalho Chehab mchehab at osg.samsung.com
Wed Jul 20 12:40:35 UTC 2016


HI Daniel,

Em Wed, 20 Jul 2016 13:56:31 +0200
Daniel Vetter <daniel.vetter at ffwll.ch> escreveu:

> In 4.8 we have a shiny new kernel doc toolchain:
> 
> https://lwn.net/Articles/692705/
> 
> I think it'd be great if interested parties (might be just a hallway
> track) sit together and figure out how to best go about converting all
> the existing docs over, and how to link it all together. I think we
> pretty much have agreement that the docbook horror show needs to die,
> but there's lots of other documentation that I think would be great to
> include in the overall (cross-linked!) kernel docs.
> 
> People who would be great to be there:
> - Jon Corbet
> - Mauro Carvalho
> - Jani Nikula
> - Markus Heiser
> - maybe Grant Likely, he made noises about sphinx/rst too
> 
> I think converting/polishing docs would also serve well as kernel
> newbie task in opw or gsoc or wherever, that might be another
> interested group. And anyone else who wants to convert over docs for
> their subsystem.
> 
> Mostly I'm just sending this out to gauge interest.

Yeah, I think we should do it. Just not sure if this is a TECH
TOPIC or a CORE one ;) Documentation will sooner or later touch
all subsystems.  So, I guess we should at least highlight some
things to the core group (Or at least do a lightning talk there).

Yet, a TECH topic would be interesting for us to discuss some
details about that.

Regards,
Mauro


More information about the Ksummit-discuss mailing list