On Tue, Jun 24, 2014 at 03:58:41AM +0400, Alexander Polakov wrote: > So I have been trying to write a new audio driver (for Xonar DS if > anyone interested) and therefore reading audio(9). > > I was confused for a while by the use of "will" here. I think it's not > clear enough that these functions should be called by the driver code. > > I'm not a native speaker, so may be it's just my lack of familiarity with > english idioms. Sorry for the noise if that's the case. >
I see what you mean. As the manual describes the interface between two layers we may need to be more precise about who calls who. Wouldn't the following be less ambigous? When the hardware is ready to accept more samples the driver shall call the .Fa intr function with the argument .Fa intrarg . > Index: audio.9 > =================================================================== > RCS file: /cvs/src/share/man/man9/audio.9,v > retrieving revision 1.23 > diff -u -r1.23 audio.9 > --- audio.9 21 Jan 2014 03:15:46 -0000 1.23 > +++ audio.9 23 Jun 2014 19:42:42 -0000 > @@ -284,7 +284,7 @@ > has been initiated (normally with DMA). > When the hardware is ready to accept more samples the function > .Fa intr > -will be called with the argument > +shall be called with the argument > .Fa intrarg . > Calling > .Fa intr > @@ -302,7 +302,7 @@ > has been initiated (normally with DMA). > When the hardware is ready to deliver more samples the function > .Fa intr > -will be called with the argument > +shall be called with the argument > .Fa intrarg . > Calling > .Fa intr > @@ -437,7 +437,7 @@ > .Fa blksize > sized block, the function > .Fa intr > -will be called with the argument > +shall be called with the argument > .Fa intrarg > (typically from the audio hardware interrupt service routine). > Once started, the transfer may be stopped using > @@ -459,7 +459,7 @@ > .Fa blksize > sized block, the function > .Fa intr > -will be called with the argument > +shall be called with the argument > .Fa intrarg > (typically from the audio hardware interrupt service routine). > Once started, the transfer may be stopped using
