[sr-dev] git:5.3:e1dc051e: modules: readme files regenerated - modules ... [skip ci]

Kamailio Dev kamailio.dev at kamailio.org
Tue Sep 8 12:47:09 CEST 2020


Module: kamailio
Branch: 5.3
Commit: e1dc051e4171cb7a441987d0c184fc210fa57063
URL: https://github.com/kamailio/kamailio/commit/e1dc051e4171cb7a441987d0c184fc210fa57063

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2020-09-08T12:47:01+02:00

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

---

Modified: src/modules/app_lua/README
Modified: src/modules/pike/README
Modified: src/modules/tls/README

---

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

---

diff --git a/src/modules/app_lua/README b/src/modules/app_lua/README
index a1f0c05984..545fb78f14 100644
--- a/src/modules/app_lua/README
+++ b/src/modules/app_lua/README
@@ -94,6 +94,9 @@ Chapter 1. Admin Guide
    To read more about KEMI exports and available KSR submodules, see:
      * http://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
 
+   Note: to have the old Lua module 'sr' available, load the 'app_lua_sr'
+   Kamailio module.
+
    Lua (http://www.lua.org) is a fast and easy to embed scripting
    language. Exported API from SIP router to Lua is documented in the
    dokuwiki.
@@ -203,7 +206,7 @@ lua_dofile("/usr/local/etc/kamailio/lua/myscript.lua");
 
    Example 1.6. lua_dostring usage
 ...
-if(!lua_dostring("sr.log([[err]], [[----------- Hello World from $fU\n]])"))
+if(!lua_dostring("KSR.log([[err]], [[----------- Hello World from $fU\n]])"))
 {
     xdbg("SCRIPT: failed to execute lua script!\n");
 }
@@ -237,7 +240,7 @@ lua_run("lua_func3", "$rU", "2", "$si");
 
    Example 1.8. lua_runstring usage
 ...
-if(!lua_runstring("sr.log([[err]], [[----------- Hello World from $fU\n]])"))
+if(!lua_runstring("KSR.log([[err]], [[----------- Hello World from $fU\n]])"))
 {
     xdbg("SCRIPT: failed to execute lua script!\n");
 }
@@ -297,7 +300,7 @@ if(!lua_runstring("sr.log([[err]], [[----------- Hello World from $fU\n]])"))
    '/usr/local/etc/kamailio/lua/myscript.lua'.
 ...
 function sr_append_fu_to_reply()
-        sr.hdr.append_to_reply("P-From: " .. sr.pv.get("$fu") .. "\r\n");
+        KSR.hdr.append_to_reply("P-From: " .. KSR.pv.get("$fu") .. "\r\n");
 end
 ...
 
diff --git a/src/modules/pike/README b/src/modules/pike/README
index a7f66697e7..beea746f45 100644
--- a/src/modules/pike/README
+++ b/src/modules/pike/README
@@ -39,6 +39,7 @@ Bogdan-Andrei Iancu
    2. RPC calls
 
         1. pike.top
+        2. pike.list
 
    3. Developer Guide
 
@@ -49,6 +50,7 @@ Bogdan-Andrei Iancu
    1.3. Set remove_latency parameter
    1.4. Set pike_log_level parameter
    1.5. pike_check_req usage
+   2.1. Using pike.top
    3.1. Tree of IP addresses
 
 Chapter 1. Admin Guide
@@ -219,6 +221,7 @@ Chapter 2. RPC calls
    Table of Contents
 
    1. pike.top
+   2. pike.list
 
 1.  pike.top
 
@@ -230,9 +233,9 @@ Chapter 2. RPC calls
 
    Some IPs could be marked as HOT depending on theirs request rates.
 
-   pike.top command takes one string parameter which specifies what kind
-   of nodes you are interested in. Possible values are HOT or ALL. If no
-   argument is given, it behaves as HOT was used.
+   pike.top command can take one string parameter which specifies what
+   kind of nodes you are interested in. Possible values are HOT or ALL. If
+   no argument is given, it behaves as HOT was used.
 
    Marking nodes HOT is done on server side, client only presents given
    data and make some postprocessing like sorting.
@@ -240,6 +243,15 @@ Chapter 2. RPC calls
    Output of this command is a simple dump of ip_tree nodes marked as
    ip-leafs.
 
+   Example 2.1. Using pike.top
+...
+kamcli rpc pike.top ALL
+...
+
+2.  pike.list
+
+   Alias for "pike.top" command.
+
 Chapter 3. Developer Guide
 
    One single tree (for both IPv4 and IPv6) is used. Each node contains a
diff --git a/src/modules/tls/README b/src/modules/tls/README
index 0a0e6650d7..99f05e22c5 100644
--- a/src/modules/tls/README
+++ b/src/modules/tls/README
@@ -1426,7 +1426,7 @@ end
 
 10.34. rand_engine (str)
 
-   Set the ranondom number generator engine for libssl.
+   Set the random number generator engine for libssl.
 
    Note: the default random number generator (PRNG) engine of libssl
    v1.1.x is not designed for multi-process applications and can result in




More information about the sr-dev mailing list