[sr-dev] git:master: acc(k): update of documentation

Module: sip-router Branch: master Commit: c9bc65cc5c008a882d28cb034f6c84ce7fa8aeb5 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=c9bc65c… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Tue Oct 12 14:59:23 2010 +0200 acc(k): update of documentation --- modules_k/acc/README | 13 +++++++++---- modules_k/acc/doc/acc_admin.xml | 14 ++++++++++---- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/modules_k/acc/README b/modules_k/acc/README index 3e38cdc..08ff24a 100644 --- a/modules_k/acc/README +++ b/modules_k/acc/README @@ -689,21 +689,25 @@ modparam("acc", "db_missed_flag", 3) 5.19. db_table_acc (string) - Table name of accounting successfull calls -- database specific. + Table name of accounting successfull calls -- database specific. It can + include config variables. Default value is “acc” Example 1.19. db_table_acc example modparam("acc", "db_table_acc", "myacc_table") +modparam("acc", "db_table_acc", "acc_$time(year)_$time(mon)") 5.20. db_table_missed_calls (string) - Table name for accounting missed calls -- database specific. + Table name for accounting missed calls -- database specific. It can + include config variables. Default value is “missed_calls” Example 1.20. db_table_missed_calls example modparam("acc", "db_table_missed_calls", "myMC_table") +modparam("acc", "db_table_missed_calls", "mc_$time(year)_$time(mon)") 5.21. db_url (string) @@ -874,13 +878,14 @@ acc_log_request("Some comment"); Meaning of the parameters is as follows: * comment - Comment to be appended. - * table - Database table to be used. + * table - Database table to be used. It can include config variables. This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. Example 1.36. acc_db_request usage ... -acc_log_request("Some comment", "Some table"); +acc_log_request("Some comment", "some_table"); +acc_log_request("200 ok", "acc_cfg_$time(year)"); ... 6.3. acc_rad_request(comment) diff --git a/modules_k/acc/doc/acc_admin.xml b/modules_k/acc/doc/acc_admin.xml index 82184fa..05bf63e 100644 --- a/modules_k/acc/doc/acc_admin.xml +++ b/modules_k/acc/doc/acc_admin.xml @@ -695,7 +695,8 @@ modparam("acc", "db_missed_flag", 3) <section> <title><varname>db_table_acc</varname> (string)</title> <para> - Table name of accounting successfull calls -- database specific. + Table name of accounting successfull calls -- database specific. It + can include config variables. </para> <para> Default value is <quote>acc</quote> @@ -704,13 +705,15 @@ modparam("acc", "db_missed_flag", 3) <title>db_table_acc example</title> <programlisting format="linespecific"> modparam("acc", "db_table_acc", "myacc_table") +modparam("acc", "db_table_acc", "acc_$time(year)_$time(mon)") </programlisting> </example> </section> <section> <title><varname>db_table_missed_calls</varname> (string)</title> <para> - Table name for accounting missed calls -- database specific. + Table name for accounting missed calls -- database specific. It + can include config variables. </para> <para> Default value is <quote>missed_calls</quote> @@ -719,6 +722,7 @@ modparam("acc", "db_table_acc", "myacc_table") <title>db_table_missed_calls example</title> <programlisting format="linespecific"> modparam("acc", "db_table_missed_calls", "myMC_table") +modparam("acc", "db_table_missed_calls", "mc_$time(year)_$time(mon)") </programlisting> </example> </section> @@ -997,7 +1001,8 @@ acc_log_request("Some comment"); <para><emphasis>comment</emphasis> - Comment to be appended.</para> </listitem> <listitem> - <para><emphasis>table</emphasis> - Database table to be used.</para> + <para><emphasis>table</emphasis> - Database table to be used. It + can include config variables.</para> </listitem> </itemizedlist> <para> @@ -1007,7 +1012,8 @@ acc_log_request("Some comment"); <title>acc_db_request usage</title> <programlisting format="linespecific"> ... -acc_log_request("Some comment", "Some table"); +acc_log_request("Some comment", "some_table"); +acc_log_request("200 ok", "acc_cfg_$time(year)"); ... </programlisting> </example>