[asterisk-dev] [Code Review] Documentation for the timing modules used in Asterisk

[Mark Michelson]

> On 2009-02-17 12:11:06, Russell Bryant wrote:
> > /trunk/doc/timing.txt, lines 64-67
> > <http://reviewboard.digium.com/r/164/diff/1/?file=2791#file2791line64>
> >
> >     It might be worth noting that as of Asterisk 1.6.2, a new conference bridge application will be available that does not require DAHDI.

Yeah, I suppose that since I already have mentioned 1.6.2-only features, namely res_timing_timerfd, it wouldn't hurt to point this out in the doc, too.


> On 2009-02-17 12:11:06, Russell Bryant wrote:
> > /trunk/doc/timing.txt, line 26
> > <http://reviewboard.digium.com/r/164/diff/1/?file=2791#file2791line26>
> >
> >     I would specify "the Linux kernel."

Agreed.


> On 2009-02-17 12:11:06, Russell Bryant wrote:
> > /trunk/doc/timing.txt, lines 16-18
> > <http://reviewboard.digium.com/r/164/diff/1/?file=2791#file2791line16>
> >
> >     This is not accurate.  There is only 1 timing thread, regardless of how many timers are open.

Oops. Just shows how much I've looked at res_timing_pthread, I suppose :P

I'll get this changed.


> On 2009-02-17 12:11:06, Russell Bryant wrote:
> > /trunk/doc/timing.txt, line 1
> > <http://reviewboard.digium.com/r/164/diff/1/?file=2791#file2791line1>
> >
> >     It would be best if the entire document was wrapped at 80 columns.

sure t'ing


> On 2009-02-17 12:11:06, Russell Bryant wrote:
> > /trunk/doc/timing.txt, lines 38-41
> > <http://reviewboard.digium.com/r/164/diff/1/?file=2791#file2791line38>
> >
> >     There is not actually any code that does this.  It will just use the highest priority timing interface.

I was under the impression that Asterisk had the ability to drop to a lower-priority timing module in the event that a higher-priority module did not work correctly. I suppose that I need to change the "Customizations" section to a "Troubleshooting/Customizations" section and explain how the customizations outlined may also be used to help fix problems related to timing.

This also gives me the idea to point people to this document in the error messages they may see.


- Mark


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://reviewboard.digium.com/r/164/#review444
-----------------------------------------------------------


On 2009-02-17 12:07:14, Mark Michelson wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://reviewboard.digium.com/r/164/
> -----------------------------------------------------------
> 
> (Updated 2009-02-17 12:07:14)
> 
> 
> Review request for Asterisk Developers and Russell Bryant.
> 
> 
> Summary
> -------
> 
> This provides documentation for the timing modules used in Asterisk beginning with Asterisk 1.6.1. The documentation provided here is dependent upon the work on review http://reviewboard.digium.com/r/162/ being placed into Asterisk.
> 
> This first upload is a rough draft, and I expect to hear quite a bit of feedback on how to improve it. I suspect that not everything that I've said is 100% accurate either, especially with regards to the timing tests described in the "What Asterisk Does with the Timing Interface" section.
> 
> 
> Diffs
> -----
> 
>   /trunk/doc/timing.txt PRE-CREATION 
> 
> Diff: http://reviewboard.digium.com/r/164/diff
> 
> 
> Testing
> -------
> 
> How exactly does one test documentation?
> 
> 
> Thanks,
> 
> Mark
> 
>