> > For comps, which are very short pieces of code with limited functions, I > think this is > sensible. For major hardware drivers like ppmc or mesa-hostmot2 I'm not > sure > that still makes sense. These drivers have many functions and lots of > I/O pins, > and separate docs may be much more reasonable. These codes have specific > maintainers who should update the docs when major changes are made to the > driver or the supported hardware. >
Some googling and discussion on IRC yesterday indicates that asciidoc can be used as the source for all the three types of documentation the linuxcnc project has: html, pdf, man-pages. There is an (old) example here: https://bugs.archlinux.org/task/7312 a2x, which produces a man-page from asciidoc, is already a requirement for the linuxcnc docs. Because asciidoc is so much more readable/writeable I'd suggest that asciidoc source files for man-pages be placed in docs/man/man.9 and the build-system be modified so a2x generates man-page, html, and pdf output where needed. (I'd test this out myself, but looking inside docs/src/Submakefile results in the same knee-jerk reaction as viewing man-source :) AW ------------------------------------------------------------------------------ LogMeIn Rescue: Anywhere, Anytime Remote support for IT. Free Trial Remotely access PCs and mobile devices and provide instant support Improve your efficiency, and focus on delivering more value-add services Discover what IT Professionals Know. Rescue delivers http://p.sf.net/sfu/logmein_12329d2d _______________________________________________ Emc-developers mailing list Emc-developers@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/emc-developers
