[sr-dev] git:master: modules/lcr: improved documentation related to defunct_gw function

Module: sip-router Branch: master Commit: 0c514703a6f9bf6e792011aad4e504ae3bd87786 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=0c51470… Author: Juha Heinanen &lt;jh(a)tutpro.com&gt; Committer: Juha Heinanen &lt;jh(a)tutpro.com&gt; Date: Fri Mar 5 06:44:03 2010 +0200 modules/lcr: improved documentation related to defunct_gw function (cherry picked from commit 98607744d233e03ba6e71f076ee4dd5e68d4407b) --- modules/lcr/README | 12 +++++------- modules/lcr/doc/lcr.xml | 2 +- modules/lcr/doc/lcr_admin.xml | 7 ++----- 3 files changed, 8 insertions(+), 13 deletions(-) diff --git a/modules/lcr/README b/modules/lcr/README index 02065f2..23a96fd 100644 --- a/modules/lcr/README +++ b/modules/lcr/README @@ -10,7 +10,7 @@ Juha Heinanen &lt;jh(a)tutpro.com&gt; - Copyright � 2005-2009 Juha Heinanen + Copyright � 2005-2010 Juha Heinanen Revision History Revision $Revision$ $Date$ __________________________________________________________________ @@ -691,15 +691,13 @@ if (!next_gw()) { 4.3. defunct_gw(period) - Defuncts gateway selected by preceding next_gw() call for a period of - seconds given as argument. Argument must be a positive integer constant - or a pseudo variable with positive integer value. Value of defunct - column in database is not updated. + Defuncts gateway denoted by lcr_id_avp and defunct_gw_avp for a period + of seconds given as argument. Argument must be a positive integer + constant or a pseudo variable with positive integer value. Value of + defunct column in database is not updated. Returns 1 on success and -1 in case of error (see syslog). - Must be preceded by successful next_gw() call. - This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. Example 1.32. defunct_gw usage diff --git a/modules/lcr/doc/lcr.xml b/modules/lcr/doc/lcr.xml index b9ac7c8..cd1c1bd 100644 --- a/modules/lcr/doc/lcr.xml +++ b/modules/lcr/doc/lcr.xml @@ -24,7 +24,7 @@ </editor> </authorgroup> <copyright> - <year>2005-2009</year> + <year>2005-2010</year> <holder>Juha Heinanen</holder> </copyright> <revhistory> diff --git a/modules/lcr/doc/lcr_admin.xml b/modules/lcr/doc/lcr_admin.xml index 06ab9ea..998535f 100644 --- a/modules/lcr/doc/lcr_admin.xml +++ b/modules/lcr/doc/lcr_admin.xml @@ -828,8 +828,8 @@ if (!next_gw()) { <function moreinfo="none">defunct_gw(period)</function> </title> <para> - Defuncts gateway selected by preceding next_gw() call - for a period of seconds given as argument. Argument + Defuncts gateway denoted by lcr_id_avp and defunct_gw_avp + for a period of seconds given as argument. Argument must be a positive integer constant or a pseudo variable with positive integer value. Value of defunct column in database is not updated. @@ -838,9 +838,6 @@ if (!next_gw()) { Returns 1 on success and -1 in case of error (see syslog). </para> <para> - Must be preceded by successful next_gw() call. - </para> - <para> This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. </para> <example>