[sr-dev] git:master: cr: documentation extension related to the prime route behaviour (port r5898)

[Henning Westerholt]

Module: sip-router
Branch: master
Commit: 5ec9f271fad97a4abbf151e55eaf509c3d9f5722
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=5ec9f271fad97a4abbf151e55eaf509c3d9f5722

Author: Henning Westerholt <henning.westerholt at 1und1.de>
Committer: Henning Westerholt <henning.westerholt at 1und1.de>
Date:   Wed Aug 19 16:40:04 2009 +0200

cr: documentation extension related to the prime route behaviour (port r5898)

---

 modules/carrierroute/README                     |   12 ++++++++++--
 modules/carrierroute/doc/carrierroute_admin.xml |   12 +++++++++++-
 2 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/modules/carrierroute/README b/modules/carrierroute/README
index eba27e5..7192926 100644
--- a/modules/carrierroute/README
+++ b/modules/carrierroute/README
@@ -511,8 +511,16 @@ rewrite_user, hash_source, descavp)
    the destination or the number of channels. This function is
    only usable with rewrite_user and prefix_matching containing a
    valid string. This string needs to be numerical if the
-   match_mode parameter is set to 10. It uses the prime hash
-   algorithm to calculate the hash values.
+   match_mode parameter is set to 10.
+
+   It uses the prime hash algorithm to calculate the hash values.
+   This means that the fuction behaves different then the normal
+   routing function. If you don't know what this prime
+   functionality is, you should just use the cr_route function.
+   The prime routing algorithm not use the configured
+   probabilities in order to route requests, it just uses a fixed
+   hash distribution. If one of the hash targets is not available,
+   and no backup rule is configured, the function will return -1.
 
    Meaning of the parameters is as follows:
      * carrier - The routing tree to be used. Additional to a
diff --git a/modules/carrierroute/doc/carrierroute_admin.xml b/modules/carrierroute/doc/carrierroute_admin.xml
index d6b927f..7814d83 100644
--- a/modules/carrierroute/doc/carrierroute_admin.xml
+++ b/modules/carrierroute/doc/carrierroute_admin.xml
@@ -507,7 +507,17 @@ cr_tree_rewrite_uri(tree, domain)
         number of channels.
         This function is only usable with rewrite_user and prefix_matching
         containing a valid string. This string needs to be numerical if the match_mode
-		parameter is set to 10. It uses the prime hash algorithm to calculate the hash values.
+        parameter is set to 10.
+            </para>
+            <para>
+        It uses the prime hash algorithm to calculate the hash values. This
+        means that the fuction behaves different then the normal routing
+        function. If you don't know what this prime functionality is,
+        you should just use the <emphasis>cr_route</emphasis> function. The
+        prime routing algorithm not use the configured probabilities in
+        order to route requests, it just uses a fixed hash distribution. If
+        one of the hash targets is not available, and no backup rule is
+        configured, the function will return -1.
 	    </para>
 	    <para>Meaning of the parameters is as follows:</para>
 	    <itemizedlist>