Rebuild documentation

OpenSIPS · Jun 24, 2023 · 0238146 · 0238146
1 parent 15732b3
commit 0238146
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 80 deletions.
diff --git a/modules/lua/README b/modules/lua/README
@@ -19,7 +19,6 @@ lua Module
               1.5.2. lua_auto_reload (int)
               1.5.3. warn_missing_free_fixup (int)
               1.5.4. lua_allocator (string)
-              1.5.5. lua_user_debug (int)
 
         1.6. Exported Functions
 
@@ -36,27 +35,32 @@ lua Module
 
               2.1.1. xdbg(message)
               2.1.2. xlog([level],message)
-              2.1.3. setUserDebug
-              2.1.4. WarnMissingFreeFixup
-              2.1.5. getpid
-              2.1.6. getmem
-              2.1.7. getmeminfo
-              2.1.8. gethostname
-              2.1.9. getType(msg)
-              2.1.10. getURI_User(msg)
-              2.1.11. getExpires(msg)
-              2.1.12. getHeader(header)
-              2.1.13. getContact(msg)
-              2.1.14. moduleFunc(msg, function, args1, args2)
-              2.1.15. getStatus(msg)
-              2.1.16. getMethod(msg)
-              2.1.17. getSrcIp(msg)
-              2.1.18. getDstIp(msg)
-              2.1.19. AVP_get(msg, name)
-              2.1.20. AVP_set(msg, name, value)
-              2.1.21. AVP_destroy(msg, name)
-              2.1.22. pseudoVar(msg, variable)
-              2.1.23. add_lump_rpl
+              2.1.3. WarnMissingFreeFixup
+              2.1.4. getpid
+              2.1.5. getmem
+              2.1.6. getmeminfo
+              2.1.7. gethostname
+              2.1.8. getType(msg)
+              2.1.9. isMyself(host, port)
+              2.1.10. grepSockInfo(host, port)
+              2.1.11. getURI_User(msg)
+              2.1.12. getExpires(msg)
+              2.1.13. getHeader(msg, header)
+              2.1.14. getContact(msg)
+              2.1.15. getRoute(msg)
+              2.1.16. moduleFunc(msg, function, args1, args2, ...)
+              2.1.17. getStatus(msg)
+              2.1.18. getMethod(msg)
+              2.1.19. getSrcIp(msg)
+              2.1.20. getDstIp(msg)
+              2.1.21. AVP_get(name)
+              2.1.22. AVP_set(name, value)
+              2.1.23. AVP_destroy(name)
+              2.1.24. pseudoVar(msg, variable)
+              2.1.25. pseudoVarSet(msg, variable, value)
+              2.1.26. scriptVarGet(variable)
+              2.1.27. scriptVarSet(variable, value)
+              2.1.28. add_lump_rpl(msg, header)
 
    3. Contributors
 
@@ -180,10 +184,6 @@ modparam("lua", "luafilename", "/etc/opensips/opensips.lua")
      * opensips (default)
      * malloc
 
-1.5.5. lua_user_debug (int)
-
-   Disable by default
-
 1.6. Exported Functions
 
 1.6.1. lua_exec(func, [param])
@@ -244,89 +244,110 @@ Chapter 2. OpenSIPS Lua API
      * INFO
      * DBG
 
-2.1.3. setUserDebug
-
-   Enable or disable the xlog feature. Disabled, the xlog function
-   has no effect.
-
-2.1.4. WarnMissingFreeFixup
+2.1.3. WarnMissingFreeFixup
 
    Dynamically change the variable warn_missing_free_fixup.
 
-2.1.5. getpid
+2.1.4. getpid
 
    Returns the current pid.
 
-2.1.6. getmem
+2.1.5. getmem
 
    Returns a table with the size of allocated memory and the
    fragmentation.
 
-2.1.7. getmeminfo
+2.1.6. getmeminfo
 
    Returns a table with memory infos.
 
-2.1.8. gethostname
+2.1.7. gethostname
 
    Returns the value of the current hostname.
 
-2.1.9. getType(msg)
+2.1.8. getType(msg)
 
    Returns "SIP_REQUEST" or "SIP_REPLY".
 
-2.1.10. getURI_User(msg)
+2.1.9. isMyself(host, port)
+
+   Test if the host and optionally the port represent one of the
+   addresses that OpenSIPS listens on.
+
+2.1.10. grepSockInfo(host, port)
+
+   Similar to isMyself(), but without taking a look into the
+   aliases.
+
+2.1.11. getURI_User(msg)
 
    Returns the user of the To URI.
 
-2.1.11. getExpires(msg)
+2.1.12. getExpires(msg)
 
    Returns the expires header of the current message.
 
-2.1.12. getHeader(header)
+2.1.13. getHeader(msg, header)
 
    Returns the value of the specified header.
 
-2.1.13. getContact(msg)
+2.1.14. getContact(msg)
 
    Returns a table with the contact header.
 
-2.1.14. moduleFunc(msg, function, args1, args2)
+2.1.15. getRoute(msg)
+
+   Returns a table with the Route header.
+
+2.1.16. moduleFunc(msg, function, args1, args2, ...)
 
    You can pass arguments to this function.
 
-2.1.15. getStatus(msg)
+2.1.17. getStatus(msg)
 
    Returns the current status if the SIP message is a SIP_REPLY.
 
-2.1.16. getMethod(msg)
+2.1.18. getMethod(msg)
 
    Returns the current method.
 
-2.1.17. getSrcIp(msg)
+2.1.19. getSrcIp(msg)
 
    Returns the IP address of the source.
 
-2.1.18. getDstIp(msg)
+2.1.20. getDstIp(msg)
 
    Returns the IP address of the destination.
 
-2.1.19. AVP_get(msg, name)
+2.1.21. AVP_get(name)
 
    Returns an AVP variable.
 
-2.1.20. AVP_set(msg, name, value)
+2.1.22. AVP_set(name, value)
 
    Defines an AVP variable.
 
-2.1.21. AVP_destroy(msg, name)
+2.1.23. AVP_destroy(name)
 
    Destroys an AVP variable.
 
-2.1.22. pseudoVar(msg, variable)
+2.1.24. pseudoVar(msg, variable)
 
    Returns a pseudoVar.
 
-2.1.23. add_lump_rpl
+2.1.25. pseudoVarSet(msg, variable, value)
+
+   Sets the value of a pseudoVar.
+
+2.1.26. scriptVarGet(variable)
+
+   Returns a script variable.
+
+2.1.27. scriptVarSet(variable, value)
+
+   Sets the value of a script variable.
+
+2.1.28. add_lump_rpl(msg, header)
 
    Add header to the reply.
 
@@ -339,7 +360,7 @@ Chapter 3. Contributors
      Name DevScore Commits Lines ++ Lines --
    1. Arnaud Chong + Eric Gouyer 37 1 4335 0
    2. Razvan Crainea (@razvancrainea) 32 25 263 219
-   3. Vlad Patrascu (@rvlad-patrascu) 20 13 273 226
+   3. Vlad Patrascu (@rvlad-patrascu) 24 16 320 274
    4. Liviu Chircu (@liviuchircu) 13 10 15 63
    5. Bogdan-Andrei Iancu (@bogdan-iancu) 8 6 9 3
    6. Vlad Paiu (@vladpaiu) 5 3 7 9
@@ -367,9 +388,9 @@ Chapter 3. Contributors
 
    Table 3.2. Most recently active contributors^(1) to this module
                      Name                   Commit Activity
-   1. Maksym Sobolyev (@sobomax)          Feb 2023 - Feb 2023
-   2. Razvan Crainea (@razvancrainea)     Feb 2012 - Feb 2023
-   3. Vlad Patrascu (@rvlad-patrascu)     May 2017 - Jul 2020
+   1. Vlad Patrascu (@rvlad-patrascu)     May 2017 - Jun 2023
+   2. Maksym Sobolyev (@sobomax)          Feb 2023 - Feb 2023
+   3. Razvan Crainea (@razvancrainea)     Feb 2012 - Feb 2023
    4. Bogdan-Andrei Iancu (@bogdan-iancu) May 2014 - Jan 2020
    5. Liviu Chircu (@liviuchircu)         Mar 2014 - Mar 2019
    6. Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018

diff --git a/modules/lua/doc/contributors.xml b/modules/lua/doc/contributors.xml
@@ -37,10 +37,10 @@
 	<row>
 		<entry>3. </entry>
 		<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
-		<entry align="center">20</entry>
-		<entry align="center">13</entry>
-		<entry align="center">273</entry>
-		<entry align="center">226</entry>
+		<entry align="center">24</entry>
+		<entry align="center">16</entry>
+		<entry align="center">320</entry>
+		<entry align="center">274</entry>
 	</row>
 	<row>
 		<entry>4. </entry>
@@ -120,18 +120,18 @@
 	<tbody>
 	<row>
 		<entry>1. </entry>
-		<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
-		<entry align="center">Feb 2023 - Feb 2023</entry>
+		<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
+		<entry align="center">May 2017 - Jun 2023</entry>
 	</row>
 	<row>
 		<entry>2. </entry>
-		<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
-		<entry align="center">Feb 2012 - Feb 2023</entry>
+		<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
+		<entry align="center">Feb 2023 - Feb 2023</entry>
 	</row>
 	<row>
 		<entry>3. </entry>
-		<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
-		<entry align="center">May 2017 - Jul 2020</entry>
+		<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
+		<entry align="center">Feb 2012 - Feb 2023</entry>
 	</row>
 	<row>
 		<entry>4. </entry>

diff --git a/modules/uac_registrant/README b/modules/uac_registrant/README
@@ -399,7 +399,7 @@ Chapter 2. Contributors
      Name DevScore Commits Lines ++ Lines --
    1. Ovidiu Sas (@ovidiusas) 141 40 5687 3266
    2. Liviu Chircu (@liviuchircu) 17 14 58 71
-   3. Bogdan-Andrei Iancu (@bogdan-iancu) 12 8 288 13
+   3. Bogdan-Andrei Iancu (@bogdan-iancu) 13 9 307 13
    4. Razvan Crainea (@razvancrainea) 10 8 21 20
    5. Vlad Patrascu (@rvlad-patrascu) 9 6 97 79
    6. Nick Altmann (@nikbyte) 4 2 35 4
@@ -426,10 +426,10 @@ Chapter 2. Contributors
 
    Table 2.2. Most recently active contributors^(1) to this module
                      Name                   Commit Activity
-   1. Liviu Chircu (@liviuchircu)         Mar 2014 - Sep 2020
-   2. Razvan Crainea (@razvancrainea)     Sep 2011 - Sep 2019
-   3. Vlad Patrascu (@rvlad-patrascu)     May 2017 - Jul 2019
-   4. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2012 - Apr 2019
+   1. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2012 - Jun 2023
+   2. Liviu Chircu (@liviuchircu)         Mar 2014 - Sep 2020
+   3. Razvan Crainea (@razvancrainea)     Sep 2011 - Sep 2019
+   4. Vlad Patrascu (@rvlad-patrascu)     May 2017 - Jul 2019
    5. Ovidiu Sas (@ovidiusas)             Feb 2011 - Mar 2019
    6. Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
    7. Nick Altmann (@nikbyte)             Nov 2015 - Dec 2015

diff --git a/modules/uac_registrant/doc/contributors.xml b/modules/uac_registrant/doc/contributors.xml
@@ -37,9 +37,9 @@
 	<row>
 		<entry>3. </entry>
 		<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
-		<entry align="center">12</entry>
-		<entry align="center">8</entry>
-		<entry align="center">288</entry>
+		<entry align="center">13</entry>
+		<entry align="center">9</entry>
+		<entry align="center">307</entry>
 		<entry align="center">13</entry>
 	</row>
 	<row>
@@ -112,24 +112,24 @@
 	<tbody>
 	<row>
 		<entry>1. </entry>
+		<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
+		<entry align="center">Dec 2012 - Jun 2023</entry>
+	</row>
+	<row>
+		<entry>2. </entry>
 		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
 		<entry align="center">Mar 2014 - Sep 2020</entry>
 	</row>
 	<row>
-		<entry>2. </entry>
+		<entry>3. </entry>
 		<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
 		<entry align="center">Sep 2011 - Sep 2019</entry>
 	</row>
 	<row>
-		<entry>3. </entry>
+		<entry>4. </entry>
 		<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
 		<entry align="center">May 2017 - Jul 2019</entry>
 	</row>
-	<row>
-		<entry>4. </entry>
-		<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
-		<entry align="center">Dec 2012 - Apr 2019</entry>
-	</row>
 	<row>
 		<entry>5. </entry>
 		<entry>Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>)</entry>