Re:The Problem with Linux Kernel Documentation, and How We'r...
by Sanddancer on Wednesday September 28, 2016 @02:48PM
(#12600199)
They missed a format that's ubiquitous, has a lot of formatting options, and has search facilities. Manpages. When someone's looking for a piece of documentation, they are usually working on a system as they do it, and man -k <thing> is a lot easier to remember than some other search tool that requires its own set of packages, etc.
[ Parent
| on HN ]
Re:The Problem with Linux Kernel Documentation, and How We'r...
by grive on Wednesday September 28, 2016 @04:08PM
(#12600882)
Manpages are not a format to write the documentation, but to display it.
You can `make mandocs` in the linux tree, then `make installmandocs` to make them easily accessible with the man command, i.e. `man struct_sk_buff` will display the definition of an sk_buff.
Re:The Problem with Linux Kernel Documentation, and How We'r...
by dend on Wednesday September 28, 2016 @04:10PM
(#12600897)
The problem with that approach is that you are limiting yourself to fundamentally primitive documentation (and by primitive I mean non-interactive). Granted, for a kernel it might be less important, but it's great when there is a good architecture diagram/image instead of 7 paragraphs.
Re:The Problem with Linux Kernel Documentation, and How We'r...
by Sanddancer on Wednesday September 28, 2016 @06:44PM
(#12601957)
Manpages can have a rather large amount of interactivity. Documents can be formatted as text, as HTML, with links, etc. The problem is that manpages are an afterthought in too much of the Linux ecosystem, so people have low expectations and low beliefs in what they can actually do. They can have tables, they can have equations, they can have graphics.
Re:The Problem with Linux Kernel Documentation, and How We'r...
by dend on Wednesday September 28, 2016 @06:54PM
(#12602011)
Out of genuine curiosity, could you link me to an existing guide from the Linux community that is based on manpages and features images and/or other interactive content?
Re:The Problem with Linux Kernel Documentation, and How We'r...
by jap on Thursday September 29, 2016 @01:25AM
(#12603440)
Not exhaustive, but I've written code that processes 50,000 or so man pages and haven't hit one.
Re:The Problem with Linux Kernel Documentation, and How We'r...
by bduhan on Wednesday September 28, 2016 @06:11PM
(#12601760)
You can build man pages with Sphinx.
Re:The Problem with Linux Kernel Documentation, and How We'r...
by dozzie on Thursday September 29, 2016 @07:27PM
(#12609596)
Have you actually tried to use this for something real? Sphinx source doesn't
seem suited for man pages at all, and formatting seems the least important bit
that doesn't fit.