Re: SOme more documentation efforts...

On Thu, 1 May 2003, Frank Mori Hess wrote:

[...]
> > here: <http://people.mech.kuleuven.ac.be/~bruyninc/comedi/html>.
> >
> First off, good work!  
It isn't :-) I'm still working hard on major changes to the device
driver section.

> I don't think it needs a revision history section.  We already have the cvs 
> logs, etc.  A simple version number would be sufficient (set equal to 
> comedilib's version).
No problem for me! So I just eliminate the whole revision history.

> Where it says: 'Comedi has once and for all solved lots of boring but 
> indispensable infrastructural things, such as: PCI bus configuration...' it 
> should not include PCI bus configuration.  The individual drivers need to 
> call the various kernel pci related functions directly, comedi doesn't help 
> much here in general (although the mite driver does some stuff that's only 
> for boards with mite chips).
Corrected!

> This statement: 'When writing a device driver, the programmer should make use 
> of the API of the kernel-space kcomedilib' is misleading.  The drivers 
> (except for a couple special exceptions) don't make use of kcomedilib 
> functions.  kcomedilib is for people writing RT kernel modules.  Rather, 
> comedidev.h is the place where driver-specific stuff is declared.
Corrected!

> The description of the linux/comedi.h include file is missing.
Added! (In the "Comedi Reference" sections.)

> 
> Where it says 'The mydriver_attach() function must... announce that the 
> hardware driver has begun initialization by a printk("comedi%d: driver: 
> ",minor);' should be removed.  If we want to enforce a particular message to 
> be displayed on attach, we might as well just do it in the core.
Corrected!

> where it says 'Drivers should report errors and warnings via a printk line 
> that starts with comedi%d: driver_name: where %d is the minor number of the 
> device.'   You should just say to use comedi_error(), which is what is 
> actually generating that format of message.
Corrected!

Thanks a lot for the support on the right time :-)

Expect a new release in a couple of hours... I first want to finish a
section on the asynchronous stuff: interrupts, s->async, ...

Herman
-- 
  K.U.Leuven, Mechanical Engineering, Robotics Research Group
<http://people.mech.kuleuven.ac.be/~bruyninc> Tel: +32 16 322480

Received on 2003-05-01Z18:19:27