[sr-dev] git:5.4:807ff5d2: modules: readme files regenerated - modules ... [skip ci]

[Kamailio Dev]

Module: kamailio
Branch: 5.4
Commit: 807ff5d216ad0dd8a620201b49c125c9c26d3559
URL: https://github.com/kamailio/kamailio/commit/807ff5d216ad0dd8a620201b49c125c9c26d3559

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2021-02-12T16:16:30+01:00

modules: readme files regenerated - modules ... [skip ci]

---

Modified: src/modules/htable/README
Modified: src/modules/rr/README

---

Diff:  https://github.com/kamailio/kamailio/commit/807ff5d216ad0dd8a620201b49c125c9c26d3559.diff
Patch: https://github.com/kamailio/kamailio/commit/807ff5d216ad0dd8a620201b49c125c9c26d3559.patch

---

diff --git a/src/modules/htable/README b/src/modules/htable/README
index ca193e2213..85f19c7102 100644
--- a/src/modules/htable/README
+++ b/src/modules/htable/README
@@ -1165,6 +1165,16 @@ kamcmd htable.stats
    items in hash tables. The event route is executed only once, after core
    and module initialization, but before Kamailio forks any child
    processes.
+
+   Note: do not expect to use functions from all other modules here, even
+   if they are loaded before the htable module, because many of them
+   initialize their runtime structures inside child init callbacks, which
+   are executed after this moment, when forking child processes. For
+   example, sqlops cannot be used, connections to database are initialized
+   in child init. Even more, it is recommended not to use functions from
+   other modules, because it can mess up what they created in mod init
+   callback and expect in child init callback. It should be ok to use
+   functions from htable module or assignment operations.
 ...
 event_route[htable:mod-init] {
     $sht(a=>x) = 1;
diff --git a/src/modules/rr/README b/src/modules/rr/README
index 9f3917c484..0ac7812437 100644
--- a/src/modules/rr/README
+++ b/src/modules/rr/README
@@ -370,7 +370,8 @@ modparam("rr", "ignore_sips", 1)
 4.9. sockname_mode (int)
 
    If set to 1, the Record-Route URI is built to contain socket name in
-   'sn' parameter.
+   'sn' parameter and then it is used to lookup the local socket for Route
+   header processing.
 
    Default value is 0.
 
@@ -502,8 +503,8 @@ remove_record_route();
 
 5.5. record_route_preset(string [,string2])
 
-   This function will put the string into Record-Route, don't use unless
-   you know what you are doing.
+   This function will put the string params into Record-Route, avoid to
+   use it unless you know what you are doing.
 
    Meaning of the parameters is as follows:
      * string - String to be inserted into the first header field; it may
@@ -515,6 +516,13 @@ remove_record_route();
    the outbound interface and the 'string2' param is pointing to the
    inbound interface.
 
+   Note: The value of parameters must not contain the SIP protocol scheme
+   (sip: or sips:), one is added based on routing requirements. Thus the
+   value has to be like "address:port;parameters", the port and parameters
+   are optional. If the second parameter is provided, do not forget to add
+   the parameter "r2=on" so the proxy processes both corresponding Route
+   headers at once.
+
    When the “outbound” module was loaded before this module this function
    will determine whether outbound is required for the request and
    generate and add a flow-token as the username part of the
@@ -559,9 +567,9 @@ record_route_advertised_address("1.2.3.4:5080");
 
    Adds a parameter to the Record-Route URI (param must be in
    “;name=value” format. The function may be called also before or after
-   the record_route() or record_route_advertised_address() calls (see
-   Section 5.3, “record_route([sparams])” or Section 5.6,
-   “record_route_advertised_address(address)”)).
+   the record_route(), record_route_advertised_address(), and
+   record_route_preset() calls (see Section 5.3, “record_route([sparams])”
+   or Section 5.6, “record_route_advertised_address(address)”)).
 
    Meaning of the parameters is as follows:
      * param - String containing the URI parameter to be added. It must