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

[Mark Michelson]

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

(Updated 2009-02-17 13:42:16.740514)


Review request for Asterisk Developers and Russell Bryant.


Changes
-------

I've updated the docs to address all of Russell's concerns.

I also made explicit mention of ztdummy in the section on res_timing_dahdi since Leif suggested that it may not be obvious to someone who is updating to 1.6.1 from an older version that res_timing_dahdi may use dahdi_dummy, which is the same as ztdummy.

I also added a section to address pj's comment on issue 14490. He asked what the purpose of using internal timing was, so I have listed the parts of Asterisk that require its use.


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 
  /trunk/res/res_timing_dahdi.c 176252 

Diff: http://reviewboard.digium.com/r/164/diff


Testing
-------

How exactly does one test documentation?


Thanks,

Mark