[sr-dev] git:sr_3.0: modules_k/nathelper: improved handle_ruri_alias() documentation

Module: sip-router Branch: sr_3.0 Commit: 7bb718bb680dd5faf398217583796247bb51813a URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=7bb718b… Author: Juha Heinanen &lt;jh(a)tutpro.com&gt; Committer: Juha Heinanen &lt;jh(a)tutpro.com&gt; Date: Wed Dec 30 22:47:35 2009 +0200 modules_k/nathelper: improved handle_ruri_alias() documentation - Improved handle_ruri_alias() documentation based on suggestion by Klaus. --- modules_k/nathelper/README | 8 +++++++- modules_k/nathelper/doc/nathelper_admin.xml | 11 ++++++++++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/modules_k/nathelper/README b/modules_k/nathelper/README index 449bfd3..cf67a99 100644 --- a/modules_k/nathelper/README +++ b/modules_k/nathelper/README @@ -848,7 +848,13 @@ start_recording(); 6.15. handle_ruri_alias() Checks if Request URI has alias param and if so, removes it and sets - $du based on its value. + $du based on its value. Note that this means that routing of request is + based on alias parameter value of Request URI rather than Request URI + itself. If you call handle_ruri_alias() on a request, make thus sure + that you screen alias parameter value of Request URI the same way as + you would screen Request URI itself. + + Note that th This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, and LOCAL_ROUTE. diff --git a/modules_k/nathelper/doc/nathelper_admin.xml b/modules_k/nathelper/doc/nathelper_admin.xml index 3a4d3c7..5f75ee2 100644 --- a/modules_k/nathelper/doc/nathelper_admin.xml +++ b/modules_k/nathelper/doc/nathelper_admin.xml @@ -1031,7 +1031,16 @@ start_recording(); </title> <para> Checks if Request URI has alias param and if so, removes - it and sets $du based on its value. + it and sets $du based on its value. Note that this + means that routing of request is based on alias + parameter value of Request URI rather than Request URI + itself. If you call handle_ruri_alias() on a request, + make thus sure that you screen alias parameter value of + Request URI the same way as you would screen + Request URI itself. + </para> + <para> + Note that th </para> <para> This function can be used from