On Fri, Dec 7, 2012 at 8:23 PM, andy pugh <bodge...@gmail.com> wrote:
> On 7 December 2012 17:23, Anders Wallin <anders.e.e.wal...@gmail.com> > wrote: > > > To make the documentation task manageable I think the HTML/PDF docs must > be > > autogenerated from comments in the source - just like man-pages for > > components written with comp are now. > > I generally write a man-page whenever I write a new component in C > (.comp files look after themselves to an extent, though many are > especially terse). > I thought that was "the rules". Write a component, write a manpage. > > Writing .comp files with tables in that format correctly in HTML and > in manpage is a bit of a game. Jepler managed to make it happen in the > bldc.comp. > Either way (separate man-pages or man-pages generated from in-source markup), it seems unsatisfactory that the list of components at http://www.linuxcnc.org/docs/2.5/html/hal/components.html is incomplete, and the list of components as man(9)-pages under "Realtime components and kernel modules" over here http://www.linuxcnc.org/docs/2.5/html/ is also incomplete! from src/hal/components the latter man.9 list does not include boss_plc modmath all of the hal_ drivers from src/hal/drivers are also missing: ax5214h evoreg motenc parport ppmc skeleton speaker stg tiro vti motenc probe_parport then in src/hal/user_comps modbus vismach Having taken a look at the native man-page format I can't say I will happily volunteer to write any of this. Isn't there anything more modern/saner that could be groff:ed into a man-page? Anders ------------------------------------------------------------------------------ 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
