|
|
Log in / Subscribe / Register

Kernel documentation with Sphinx, part 1: how we got here

Kernel documentation with Sphinx, part 1: how we got here

Posted Jul 18, 2016 9:07 UTC (Mon) by jezuch (subscriber, #52988)
In reply to: Kernel documentation with Sphinx, part 1: how we got here by neilbrown
Parent article: Kernel documentation with Sphinx, part 1: how we got here

> I think literate programing can work very well when the programmer fully understands the problem they are trying to solve and can then present it coherently as a lesson to the reader.

Obviously, it also helps if the person writing it all is a good writer. Most of us suck at this :)


to post comments

Kernel documentation with Sphinx, part 1: how we got here

Posted Jul 18, 2016 18:26 UTC (Mon) by liw (subscriber, #6379) [Link]

It has, in fact, been my experience that software developers will avoid writing prose longer than a line on IRC. They will got great lengths to avoid it, up to and including standing between decorative bushes of vegetation while wearing camouflage clothing.

It's sad, and not just because it makes those of us who like writing to stand out.

Kernel documentation with Sphinx, part 1: how we got here

Posted Jul 18, 2016 21:30 UTC (Mon) by neilbrown (subscriber, #359) [Link] (1 responses)

I feel compelled to quote some wise words from a favorite novel by Jane Austen:

"My fingers," said Elizabeth, "do not move over this instrument
in the masterly manner which I see so many women's do. They
have not the same force or rapidity, and do not produce the
same expression. But then I have always supposed it to be my
own fault--because I will not take the trouble of practising.

Kernel documentation with Sphinx, part 1: how we got here

Posted Jul 19, 2016 16:10 UTC (Tue) by ortalo (guest, #4654) [Link]

Just a quick ref., cause... I knew the woman who knew the man who... and also cause it seems to me it's worth reading or listening (again).

Sorry for not finding a good link to the full (published) paper but the slides are here: http://fose.ethz.ch/slides/parnas.pdf

and you will find a video around here: https://youtu.be/dn8bVhfAv0c


Copyright © 2026, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds