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

[Mark Michelson]

> On 2009-02-17 14:28:51, Kevin Fleming wrote:
> >

I've updated the docs here to reflect Kevin's comments, but I do not think that the docs are necessarily in a finished state. Unfortunately, I'm going to be gone for the next week and my time devoted to Asterisk is going to be inconsistent at best and nonexistent at worst. Since this documentation is a blocker for 1.6.1, I think it's important that this gets finished even if I'm not the one to do it.

For whoever takes over this task, the get_review script in repotools is your friend.


> On 2009-02-17 14:28:51, Kevin Fleming wrote:
> > /trunk/doc/timing.txt, line 5
> > <http://reviewboard.digium.com/r/164/diff/2/?file=2792#file2792line5>
> >
> >     s/wasintroduced/was introduced/

fixed


> On 2009-02-17 14:28:51, Kevin Fleming wrote:
> > /trunk/doc/timing.txt, line 33
> > <http://reviewboard.digium.com/r/164/diff/2/?file=2792#file2792line33>
> >
> >     s/it's/is/ would be slightly clearer

I assume you meant s/it's/it is/. Fixed.


> On 2009-02-17 14:28:51, Kevin Fleming wrote:
> > /trunk/doc/timing.txt, line 40
> > <http://reviewboard.digium.com/r/164/diff/2/?file=2792#file2792line40>
> >
> >     s/thiswriting/this writing/

fixed.


> On 2009-02-17 14:28:51, Kevin Fleming wrote:
> > /trunk/doc/timing.txt, lines 44-46
> > <http://reviewboard.digium.com/r/164/diff/2/?file=2792#file2792line44>
> >
> >     I don't think this paragraph is actually correct.
> >     
> >     MeetMe conferences don't require timing, they require conference mixing, which is not provided by the modules referred to in this document.
> >     
> >     'DAHDI calls' require internal timing? I don't understand that, to be honest. If chan_dahdi is being used for calls, then DAHDI timing is available, but in any case, the timing source is not actually used for the calls.
> >     
> >     When I grep for ast_timer_open() in trunk, the only hits are in channel.c and chan_iax2.c. The latter is used for IAX2 trunking (as you've already documented), and the former is used for any purpose where a channel needs timing, which is primarily used for generators and file playback when internal_timing is enabled in asterisk.conf.
> >     
> >     This might need a more thorough analysis.

All right. For now, I've slimmed this down to just "Asterisk requires a timing interface for IAX2 trunking." I suppose that to better answer pj's question on the corresponding issue, it may be good to tell what the advantages are (if any) to using internal timing.


> On 2009-02-17 14:28:51, Kevin Fleming wrote:
> > /trunk/doc/timing.txt, lines 74-80
> > <http://reviewboard.digium.com/r/164/diff/2/?file=2792#file2792line74>
> >
> >     Do we really want to suggest that people modify the source to accomplish this, when the normal configuration-type solutions are so easy?

Yeah, you're probably right. I initially wrote this suggestion when I was under the impression that we'd fall back to a lower-priority timing module if the highest-priority one was not functioning properly. Since re-prioritizing the timing modules would have the same net effect as either of the other two changes, this can be removed.


- Mark


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


On 2009-02-17 13:42:16, Mark Michelson wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://reviewboard.digium.com/r/164/
> -----------------------------------------------------------
> 
> (Updated 2009-02-17 13:42:16)
> 
> 
> 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 
>   /trunk/res/res_timing_dahdi.c 176252 
> 
> Diff: http://reviewboard.digium.com/r/164/diff
> 
> 
> Testing
> -------
> 
> How exactly does one test documentation?
> 
> 
> Thanks,
> 
> Mark
> 
>