Skip to content

Never use Doxygen or ASCIIDoc for Man stuff

Jason Charney edited this page Jan 19, 2015 · 4 revisions

Writing a man page REALLY isn't that hard. But some people still want to use Doxygen or ASCIIDoc to turn what should have been a simple text file into a massive wiki that requires you to install an extra gigabyte of stuff for what should have just been a program smaller than 2 Megabytes.

If such a project is ever incorporated into [Rigel], it will be forked and the documentation stripped out and rewritten. If it turns out that other things like using sh, zsh, or csh is used in bash scripts or if Python 3 is explicitly used and required, those things will be rewritten and ultimately the project will likely be renamed.

You should never push users to use the latest software unless it is absolutely necessary. And you should never have to make something simple so complicated.

TLDR: KISS

See Also

  • [KISS](Keep It Simple Stupid)

External Sources

Clone this wiki locally