Rebuild documentation

OpenSIPS · Aug 19, 2023 · 6ce670d · 6ce670d
1 parent b162850
commit 6ce670d
Show file tree

Hide file tree

Showing 14 changed files with 178 additions and 130 deletions.
diff --git a/modules/db_perlvdb/README b/modules/db_perlvdb/README
@@ -275,7 +275,7 @@ Chapter 3. Contributors
    1. Bogdan-Andrei Iancu (@bogdan-iancu) 26 19 257 202
    2. Bastian Friedrich 18 2 1820 18
    3. Liviu Chircu (@liviuchircu) 13 11 25 55
-   4. Razvan Crainea (@razvancrainea) 10 8 26 13
+   4. Razvan Crainea (@razvancrainea) 11 9 27 14
    5. Daniel-Constantin Mierla (@miconda) 9 7 27 25
    6. Maksym Sobolyev (@sobomax) 5 3 5 21
    7. Henning Westerholt (@henningw) 4 2 14 13
@@ -306,9 +306,9 @@ Chapter 3. Contributors
 
    Table 3.2. Most recently active contributors^(1) to this module
                       Name                   Commit Activity
-   1.  Maksym Sobolyev (@sobomax)          Oct 2022 - Feb 2023
-   2.  Liviu Chircu (@liviuchircu)         Mar 2014 - May 2020
-   3.  Razvan Crainea (@razvancrainea)     Aug 2015 - Sep 2019
+   1.  Razvan Crainea (@razvancrainea)     Aug 2015 - Aug 2023
+   2.  Maksym Sobolyev (@sobomax)          Oct 2022 - Feb 2023
+   3.  Liviu Chircu (@liviuchircu)         Mar 2014 - May 2020
    4.  Bogdan-Andrei Iancu (@bogdan-iancu) Jul 2007 - Apr 2019
    5.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
    6.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018

diff --git a/modules/db_perlvdb/doc/contributors.xml b/modules/db_perlvdb/doc/contributors.xml
@@ -45,10 +45,10 @@
 	<row>
 		<entry>4. </entry>
 		<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
-		<entry align="center">10</entry>
-		<entry align="center">8</entry>
-		<entry align="center">26</entry>
-		<entry align="center">13</entry>
+		<entry align="center">11</entry>
+		<entry align="center">9</entry>
+		<entry align="center">27</entry>
+		<entry align="center">14</entry>
 	</row>
 	<row>
 		<entry>5. </entry>
@@ -128,18 +128,18 @@
 	<tbody>
 	<row>
 		<entry>1. </entry>
-		<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
-		<entry align="center">Oct 2022 - Feb 2023</entry>
+		<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
+		<entry align="center">Aug 2015 - Aug 2023</entry>
 	</row>
 	<row>
 		<entry>2. </entry>
-		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
-		<entry align="center">Mar 2014 - May 2020</entry>
+		<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
+		<entry align="center">Oct 2022 - Feb 2023</entry>
 	</row>
 	<row>
 		<entry>3. </entry>
-		<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
-		<entry align="center">Aug 2015 - Sep 2019</entry>
+		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
+		<entry align="center">Mar 2014 - May 2020</entry>
 	</row>
 	<row>
 		<entry>4. </entry>

diff --git a/modules/db_sqlite/README b/modules/db_sqlite/README
@@ -135,7 +135,7 @@ Chapter 2. Contributors
    commits^(2) and lines added/removed^(3)
      Name DevScore Commits Lines ++ Lines --
    1. Ionut Ionita (@ionutrazvanionita) 80 28 3744 1276
-   2. Razvan Crainea (@razvancrainea) 13 11 85 31
+   2. Razvan Crainea (@razvancrainea) 14 12 96 33
    3. Liviu Chircu (@liviuchircu) 9 7 21 49
    4. Jarrod Baumann (@jarrodb) 5 3 7 4
    5. Vlad Patrascu (@rvlad-patrascu) 4 2 3 2
@@ -167,8 +167,8 @@ Chapter 2. Contributors
 
    Table 2.2. Most recently active contributors^(1) to this module
                       Name                   Commit Activity
-   1.  Maksym Sobolyev (@sobomax)          Feb 2023 - Feb 2023
-   2.  Razvan Crainea (@razvancrainea)     Aug 2015 - Nov 2021
+   1.  Razvan Crainea (@razvancrainea)     Aug 2015 - Aug 2023
+   2.  Maksym Sobolyev (@sobomax)          Feb 2023 - Feb 2023
    3.  Liviu Chircu (@liviuchircu)         May 2016 - Mar 2021
    4.  Eric Green                          Aug 2020 - Aug 2020
    5.  Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2019 - Apr 2019

diff --git a/modules/db_sqlite/doc/contributors.xml b/modules/db_sqlite/doc/contributors.xml
@@ -29,10 +29,10 @@
 	<row>
 		<entry>2. </entry>
 		<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
-		<entry align="center">13</entry>
-		<entry align="center">11</entry>
-		<entry align="center">85</entry>
-		<entry align="center">31</entry>
+		<entry align="center">14</entry>
+		<entry align="center">12</entry>
+		<entry align="center">96</entry>
+		<entry align="center">33</entry>
 	</row>
 	<row>
 		<entry>3. </entry>
@@ -128,13 +128,13 @@
 	<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>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
+		<entry align="center">Aug 2015 - Aug 2023</entry>
 	</row>
 	<row>
 		<entry>2. </entry>
-		<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
-		<entry align="center">Aug 2015 - Nov 2021</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>

diff --git a/modules/regex/README b/modules/regex/README
@@ -29,6 +29,8 @@ Regex Module
         1.5. Exported MI Functions
 
               1.5.1. regex_reload
+              1.5.2. regex_match
+              1.5.3. regex_match_group
 
         1.6. Installation and Running
 
@@ -275,7 +277,50 @@ if (pcre_match_group($rU, 2)) {
    Parameters: none
 
    MI FIFO Command Format:
+...
 opensips-cli -x mi regex_reload
+...
+
+1.5.2.  regex_match
+
+   Matches the given string parameter against the regular
+   expression pcre_regex. Returns "Match" if it matches, "Not
+   Match" otherwise.
+
+   Name: regex_match
+
+   Parameters:
+     * string
+     * pcre_regex
+
+   MI FIFO Command Format:
+...
+opensips-cli -x mi regex_match string="1234" pcre_regex="^1234$"
+"Match"
+opensips-cli -x mi regex_match string="1234" pcre_regex="^1235$"
+"Not Match"
+...
+
+1.5.3.  regex_match_group
+
+   It uses the groups readed from the text file to match the given
+   string parameter against the compiled regular expression in
+   group number group. Returns "Match" if it matches, "Not Match"
+   otherwise.
+
+   Name: regex_match_group
+
+   Parameters:
+     * string
+     * group
+
+   MI FIFO Command Format:
+...
+opensips-cli -x mi regex_match_group string="1234" group="0"
+"Match"
+opensips-cli -x mi regex_match_group string="1234" group="1"
+"Not Match"
+...
 
 1.6. Installation and Running
 
@@ -384,17 +429,18 @@ Chapter 2. Contributors
    commits^(2) and lines added/removed^(3)
      Name DevScore Commits Lines ++ Lines --
    1. Iñaki Baz Castillo 15 3 1242 2
-   2. Razvan Crainea (@razvancrainea) 13 11 41 24
+   2. Razvan Crainea (@razvancrainea) 14 12 43 26
    3. Liviu Chircu (@liviuchircu) 12 10 25 42
    4. Vlad Patrascu (@rvlad-patrascu) 9 6 63 88
    5. Bogdan-Andrei Iancu (@bogdan-iancu) 8 6 12 7
-   6. Norman Brandinger (@NormB) 5 3 4 4
-   7. Sergio Gutierrez 3 1 19 1
-   8. Ovidiu Sas (@ovidiusas) 3 1 13 11
-   9. Anca Vamanu 3 1 6 3
-   10. Maksym Sobolyev (@sobomax) 3 1 3 3
+   6. MonkeyTester 6 3 188 14
+   7. Norman Brandinger (@NormB) 5 3 4 4
+   8. Sergio Gutierrez 3 1 19 1
+   9. Ovidiu Sas (@ovidiusas) 3 1 13 11
+   10. Anca Vamanu 3 1 6 3
 
-   All remaining contributors: Marius Zbihlei.
+   All remaining contributors: Maksym Sobolyev (@sobomax), Marius
+   Zbihlei.
 
    (1) DevScore = author_commits + author_lines_added /
    (project_lines_added / project_commits) + author_lines_deleted
@@ -416,18 +462,18 @@ Chapter 2. Contributors
 
    Table 2.2. Most recently active contributors^(1) to this module
                       Name                   Commit Activity
-   1.  Norman Brandinger (@NormB)          Apr 2023 - Apr 2023
-   2.  Maksym Sobolyev (@sobomax)          Feb 2023 - Feb 2023
-   3.  Razvan Crainea (@razvancrainea)     Sep 2011 - Sep 2019
-   4.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
-   5.  Bogdan-Andrei Iancu (@bogdan-iancu) Feb 2009 - Apr 2019
-   6.  Liviu Chircu (@liviuchircu)         Mar 2014 - Nov 2018
-   7.  Ovidiu Sas (@ovidiusas)             Jan 2013 - Jan 2013
-   8.  Marius Zbihlei                      Sep 2010 - Sep 2010
-   9.  Iñaki Baz Castillo                  Feb 2009 - Jul 2010
-   10. Anca Vamanu                         Sep 2009 - Sep 2009
-
-   All remaining contributors: Sergio Gutierrez.
+   1.  Razvan Crainea (@razvancrainea)     Sep 2011 - Aug 2023
+   2.  MonkeyTester                        Aug 2023 - Aug 2023
+   3.  Norman Brandinger (@NormB)          Apr 2023 - Apr 2023
+   4.  Maksym Sobolyev (@sobomax)          Feb 2023 - Feb 2023
+   5.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
+   6.  Bogdan-Andrei Iancu (@bogdan-iancu) Feb 2009 - Apr 2019
+   7.  Liviu Chircu (@liviuchircu)         Mar 2014 - Nov 2018
+   8.  Ovidiu Sas (@ovidiusas)             Jan 2013 - Jan 2013
+   9.  Marius Zbihlei                      Sep 2010 - Sep 2010
+   10. Iñaki Baz Castillo                  Feb 2009 - Jul 2010
+
+   All remaining contributors: Anca Vamanu, Sergio Gutierrez.
 
    (1) including any documentation-related commits, excluding
    merge commits
@@ -436,9 +482,9 @@ Chapter 3. Documentation
 
 3.1. Contributors
 
-   Last edited by: Vlad Patrascu (@rvlad-patrascu), Razvan Crainea
-   (@razvancrainea), Liviu Chircu (@liviuchircu), Bogdan-Andrei
-   Iancu (@bogdan-iancu), Iñaki Baz Castillo.
+   Last edited by: MonkeyTester, Vlad Patrascu (@rvlad-patrascu),
+   Razvan Crainea (@razvancrainea), Liviu Chircu (@liviuchircu),
+   Bogdan-Andrei Iancu (@bogdan-iancu), Iñaki Baz Castillo.
 
    Documentation Copyrights: