Anders Wallin wrote: >>> All of those are written in C so a man page would have to be written by >>> hand. Only components written using Comp get auto generated man pages. >>> In any case I doubt a newbee can find a man page with both hands... much >>> less know to look for a man page. >>> >>> >> Actually, what is in the integrator's manual could be reformatted and >> abbreviated a >> bit for a man page, I think. Should we do that? >> > > Yes, but preferably with some mechanism that integrates the documentation > with the source, like comp does. If the man-page documentation is separate > from the source-code they will diverge - sooner or later. > 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.
But, maybe you are right, **IF** the code that automatically extracts the docs actually does justice to the formatting. I'd want to be sure that works well before changing. Jon ------------------------------------------------------------------------------ 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
