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

[Mark Michelson]

Mark Michelson wrote:
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://reviewboard.digium.com/r/164/
> -----------------------------------------------------------
> 
> (Updated 2009-02-17 18:43:54.497841)
> 
> 
> Review request for Asterisk Developers and Russell Bryant.
> 
> 
> Changes
> -------
> 
> Removed item 3) from the Customizations/Troubleshooting section.
> 
> 
> 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 (updated)
> -----
> 
>   /trunk/doc/timing.txt PRE-CREATION 
> 
> Diff: http://reviewboard.digium.com/r/164/diff
> 
> 
> Testing
> -------
> 
> How exactly does one test documentation?
> 
> 
> Thanks,
> 
> Mark
> 

I see that during my absence, there were no new comments made on this. As far as 
I recall, this bit of documentation is blocking a potential 1.6.1 release, so 
its importance is somewhat high.

My biggest concern with the document as-is right now is the "What Asterisk does 
with the Timing Interfaces" section. It explains Asterisk's preference for which 
timing interfaces pretty well, but I also wanted to use the section to explain 
exactly what internal timing is used for. Right now, I have a single sentence 
stating that internal timing is required for IAX2 trunking. I would like to 
expand this section to include other instances where internal timing is used, as 
well as potential benefits for using internal timing. As far as I understand, 
the only other place where Asterisk currently uses internal timing is for file 
playback. Are there other situations where internal timing is used? Are there 
any inherent benefits to using internal timing as opposed to ... whatever the 
alternative is?

I'd really like to get this document finalized today, if at all possible.

Mark Michelson