Skip to content

Commit

Permalink
Rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@opensips-github
opensips-github committed Dec 1, 2024
1 parent c80786b commit cc6c368
Show file tree
Hide file tree
Showing 6 changed files with 84 additions and 114 deletions.
4 changes: 2 additions & 2 deletions modules/db_mysql/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,8 @@ Chapter 2. Contributors
2. Bogdan-Andrei Iancu (@bogdan-iancu) 99 72 1574 793
3. Henning Westerholt (@henningw) 57 30 693 1239
4. Liviu Chircu (@liviuchircu) 43 34 581 206
5. Daniel-Constantin Mierla (@miconda) 28 20 571 154
6. Razvan Crainea (@razvancrainea) 26 21 240 62
5. Razvan Crainea (@razvancrainea) 29 24 246 66
6. Daniel-Constantin Mierla (@miconda) 28 20 571 154
7. Andrei Pelinescu-Onciul 16 14 52 49
8. Vlad Paiu (@vladpaiu) 15 12 185 25
9. Vlad Patrascu (@rvlad-patrascu) 12 8 179 78
Expand Down
16 changes: 8 additions & 8 deletions modules/db_mysql/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,20 +52,20 @@
</row>
<row>
<entry>5. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">29</entry>
<entry align="center">24</entry>
<entry align="center">246</entry>
<entry align="center">66</entry>
</row>
<row>
<entry>6. </entry>
<entry>Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>)</entry>
<entry align="center">28</entry>
<entry align="center">20</entry>
<entry align="center">571</entry>
<entry align="center">154</entry>
</row>
<row>
<entry>6. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">26</entry>
<entry align="center">21</entry>
<entry align="center">240</entry>
<entry align="center">62</entry>
</row>
<row>
<entry>7. </entry>
<entry>Andrei Pelinescu-Onciul</entry>
Expand Down
92 changes: 31 additions & 61 deletions modules/dispatcher/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -710,24 +710,10 @@ modparam("dispatcher", "cluster_probing_mode", "distributed")
1.3.26. partition (string)

Define a new partition (data source) with the following
properties:

"db_url", "table_name", "dst_avp", "grp_avp",
properties: "db_url", "table_name", "dst_avp", "grp_avp",
"cnt_avp", "sock_avp", "attrs_avp", "script_attrs",
"ds_define_blacklist", "ping_sock"

All these properties are optional, having appropriate default values.

If the OpenSIPS server has multiple interfaces the "ping_sock" can be
used to specify the interface to be used for sending pings.

For example, a server acting as an SBC may have a public and a private interface.
There can be two partitions defined, one for carriers and the other for proxies.
Using the "ping_sock" parameter, the server can send pings to the carriers over
the public interface and to the proxies over the private interface. Additional
value can be realized when multiple SBCs are able to use the same carriers and
proxies tables. In this case, each SBC can use its own public and private
interfaces to send pings to the carriers and proxies.
"ds_define_blacklist". All these properties are optional,
having appropriate default values.

The syntax is: "partition_name: param1 = value1; param2 =
value2". Each value format is the same as the one used to
Expand Down Expand Up @@ -758,23 +744,6 @@ modparam("dispatcher", "partition",
modparam("dispatcher", "partition", "default: trunks")
...

Example 1.29. Define the 'carriers' and 'proxies' partitions
using the 'ping_sock' to specify which interface is to be used
to send pings.
...
modparam("dispatcher", "partition",
"carriers:
db_url = mysql://user:passwd@localhost/database;
table_name = carriers;
ping_sock = udp:public_ip:public_port")

modparam("dispatcher", "partition",
"proxies:
db_url = mysql://user:passwd@localhost/database;
table_name = proxies;
ping_sock = udp:private_ip:private_port")
...

1.3.27. table_name (string)

The default name of the table from which to load dispatcher
Expand Down Expand Up @@ -1559,14 +1528,15 @@ Chapter 3. Contributors

All remaining contributors: Carsten Bock, Ionel Cerghit
(@ionel-cerghit), Elena-Ramona Modroiu, Maksym Sobolyev
(@sobomax), John Burke (@john08burke), Klaus Darilion, Anca
Vamanu, Jarrod Baumann (@jarrodb), wangdd, Walter Doekes
(@wdoekes), Nick Altmann (@nikbyte), Jan Janak (@janakj),
Andrei Pelinescu-Onciul, Peter Lemenkov (@lemenkov), Stanislaw
Pitucha, Federico Cabiddu, Konstantin Bokarius, Alexandra
Titoc, Andreas Granig, John Riordan, Aron Podrigal (@ar45),
Julián Moreno Patiño, Kevin McAllister, Roman Sevko, UnixDev,
David Sanders, Edson Gellert Schubert.
(@sobomax), John Burke (@john08burke), Norman Brandinger
(@NormB), Klaus Darilion, Anca Vamanu, Jarrod Baumann
(@jarrodb), wangdd, Walter Doekes (@wdoekes), Nick Altmann
(@nikbyte), Jan Janak (@janakj), Andrei Pelinescu-Onciul, Peter
Lemenkov (@lemenkov), Stanislaw Pitucha, Federico Cabiddu,
Konstantin Bokarius, Alexandra Titoc, Andreas Granig, John
Riordan, Aron Podrigal (@ar45), Julián Moreno Patiño, Kevin
McAllister, Roman Sevko, UnixDev, David Sanders, Edson Gellert
Schubert.

(1) DevScore = author_commits + author_lines_added /
(project_lines_added / project_commits) + author_lines_deleted
Expand All @@ -1588,25 +1558,25 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Alexandra Titoc Sep 2024 - Sep 2024
2. Liviu Chircu (@liviuchircu) Aug 2012 - Sep 2024
3. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2005 - Feb 2024
4. Vlad Paiu (@vladpaiu) Mar 2012 - Dec 2023
5. Maksym Sobolyev (@sobomax) Feb 2023 - Nov 2023
6. Razvan Crainea (@razvancrainea) May 2011 - Nov 2023
7. wangdd Apr 2023 - May 2023
8. Vlad Patrascu (@rvlad-patrascu) May 2017 - Jul 2022
9. John Burke (@john08burke) Feb 2021 - Jan 2022
10. Peter Lemenkov (@lemenkov) Jun 2018 - Feb 2020

All remaining contributors: Roman Sevko, Nick Altmann
(@nikbyte), Ionel Cerghit (@ionel-cerghit), Ionut Ionita
(@ionutrazvanionita), Julián Moreno Patiño, Jarrod Baumann
(@jarrodb), Ovidiu Sas (@ovidiusas), David Sanders, Aron
Podrigal (@ar45), Andrei Datcu (@andrei-datcu), Walter Doekes
(@wdoekes), Stanislaw Pitucha, Anca Vamanu, John Riordan,
UnixDev, Kevin McAllister, Klaus Darilion, Carsten Bock,
Daniel-Constantin Mierla (@miconda), Henning Westerholt
1. Norman Brandinger (@NormB) Nov 2024 - Nov 2024
2. Alexandra Titoc Sep 2024 - Sep 2024
3. Liviu Chircu (@liviuchircu) Aug 2012 - Sep 2024
4. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2005 - Feb 2024
5. Vlad Paiu (@vladpaiu) Mar 2012 - Dec 2023
6. Maksym Sobolyev (@sobomax) Feb 2023 - Nov 2023
7. Razvan Crainea (@razvancrainea) May 2011 - Nov 2023
8. wangdd Apr 2023 - May 2023
9. Vlad Patrascu (@rvlad-patrascu) May 2017 - Jul 2022
10. John Burke (@john08burke) Feb 2021 - Jan 2022

All remaining contributors: Peter Lemenkov (@lemenkov), Roman
Sevko, Nick Altmann (@nikbyte), Ionel Cerghit (@ionel-cerghit),
Ionut Ionita (@ionutrazvanionita), Julián Moreno Patiño, Jarrod
Baumann (@jarrodb), Ovidiu Sas (@ovidiusas), David Sanders,
Aron Podrigal (@ar45), Andrei Datcu (@andrei-datcu), Walter
Doekes (@wdoekes), Stanislaw Pitucha, Anca Vamanu, John
Riordan, UnixDev, Kevin McAllister, Klaus Darilion, Carsten
Bock, Daniel-Constantin Mierla (@miconda), Henning Westerholt
(@henningw), Konstantin Bokarius, Edson Gellert Schubert,
Federico Cabiddu, Elena-Ramona Modroiu, Andreas Granig, Andrei
Pelinescu-Onciul, Jan Janak (@janakj).
Expand Down
30 changes: 15 additions & 15 deletions modules/dispatcher/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@
</tbody>
</tgroup>
</table>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Carsten Bock, Ionel Cerghit (<ulink url="https://github.com/ionel-cerghit">@ionel-cerghit</ulink>), Elena-Ramona Modroiu, Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>), John Burke (<ulink url="https://github.com/john08burke">@john08burke</ulink>), Klaus Darilion, Anca Vamanu, Jarrod Baumann (<ulink url="https://github.com/jarrodb">@jarrodb</ulink>), wangdd, Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>), Jan Janak (<ulink url="https://github.com/janakj">@janakj</ulink>), Andrei Pelinescu-Onciul, Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Stanislaw Pitucha, Federico Cabiddu, Konstantin Bokarius, Alexandra Titoc, Andreas Granig, John Riordan, Aron Podrigal (<ulink url="https://github.com/ar45">@ar45</ulink>), Julián Moreno Patiño, Kevin McAllister, Roman Sevko, UnixDev, David Sanders, Edson Gellert Schubert.</para>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Carsten Bock, Ionel Cerghit (<ulink url="https://github.com/ionel-cerghit">@ionel-cerghit</ulink>), Elena-Ramona Modroiu, Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>), John Burke (<ulink url="https://github.com/john08burke">@john08burke</ulink>), Norman Brandinger (<ulink url="https://github.com/NormB">@NormB</ulink>), Klaus Darilion, Anca Vamanu, Jarrod Baumann (<ulink url="https://github.com/jarrodb">@jarrodb</ulink>), wangdd, Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>), Jan Janak (<ulink url="https://github.com/janakj">@janakj</ulink>), Andrei Pelinescu-Onciul, Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Stanislaw Pitucha, Federico Cabiddu, Konstantin Bokarius, Alexandra Titoc, Andreas Granig, John Riordan, Aron Podrigal (<ulink url="https://github.com/ar45">@ar45</ulink>), Julián Moreno Patiño, Kevin McAllister, Roman Sevko, UnixDev, David Sanders, Edson Gellert Schubert.</para>
<para>
<emphasis>(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)</emphasis>
</para>
Expand All @@ -128,58 +128,58 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Norman Brandinger (<ulink url="https://github.com/NormB">@NormB</ulink>)</entry>
<entry align="center">Nov 2024 - Nov 2024</entry>
</row>
<row>
<entry>2. </entry>
<entry>Alexandra Titoc</entry>
<entry align="center">Sep 2024 - Sep 2024</entry>
</row>
<row>
<entry>2. </entry>
<entry>3. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Aug 2012 - Sep 2024</entry>
</row>
<row>
<entry>3. </entry>
<entry>4. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Oct 2005 - Feb 2024</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">Mar 2012 - Dec 2023</entry>
</row>
<row>
<entry>5. </entry>
<entry>6. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Feb 2023 - Nov 2023</entry>
</row>
<row>
<entry>6. </entry>
<entry>7. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">May 2011 - Nov 2023</entry>
</row>
<row>
<entry>7. </entry>
<entry>8. </entry>
<entry>wangdd</entry>
<entry align="center">Apr 2023 - May 2023</entry>
</row>
<row>
<entry>8. </entry>
<entry>9. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Jul 2022</entry>
</row>
<row>
<entry>9. </entry>
<entry>10. </entry>
<entry>John Burke (<ulink url="https://github.com/john08burke">@john08burke</ulink>)</entry>
<entry align="center">Feb 2021 - Jan 2022</entry>
</row>
<row>
<entry>10. </entry>
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
<entry align="center">Jun 2018 - Feb 2020</entry>
</row>
</tbody>
</tgroup>
</table>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Roman Sevko, Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>), Ionel Cerghit (<ulink url="https://github.com/ionel-cerghit">@ionel-cerghit</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Julián Moreno Patiño, Jarrod Baumann (<ulink url="https://github.com/jarrodb">@jarrodb</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>), David Sanders, Aron Podrigal (<ulink url="https://github.com/ar45">@ar45</ulink>), Andrei Datcu (<ulink url="https://github.com/andrei-datcu">@andrei-datcu</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Stanislaw Pitucha, Anca Vamanu, John Riordan, UnixDev, Kevin McAllister, Klaus Darilion, Carsten Bock, Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Henning Westerholt (<ulink url="https://github.com/henningw">@henningw</ulink>), Konstantin Bokarius, Edson Gellert Schubert, Federico Cabiddu, Elena-Ramona Modroiu, Andreas Granig, Andrei Pelinescu-Onciul, Jan Janak (<ulink url="https://github.com/janakj">@janakj</ulink>).</para>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Roman Sevko, Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>), Ionel Cerghit (<ulink url="https://github.com/ionel-cerghit">@ionel-cerghit</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Julián Moreno Patiño, Jarrod Baumann (<ulink url="https://github.com/jarrodb">@jarrodb</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>), David Sanders, Aron Podrigal (<ulink url="https://github.com/ar45">@ar45</ulink>), Andrei Datcu (<ulink url="https://github.com/andrei-datcu">@andrei-datcu</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Stanislaw Pitucha, Anca Vamanu, John Riordan, UnixDev, Kevin McAllister, Klaus Darilion, Carsten Bock, Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Henning Westerholt (<ulink url="https://github.com/henningw">@henningw</ulink>), Konstantin Bokarius, Edson Gellert Schubert, Federico Cabiddu, Elena-Ramona Modroiu, Andreas Granig, Andrei Pelinescu-Onciul, Jan Janak (<ulink url="https://github.com/janakj">@janakj</ulink>).</para>
<para>
<emphasis>(1) including any documentation-related commits, excluding merge commits</emphasis>
</para>
Expand Down
22 changes: 11 additions & 11 deletions modules/usrloc/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1699,7 +1699,7 @@ Chapter 3. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Jan Janak (@janakj) 414 117 15689 10095
2. Liviu Chircu (@liviuchircu) 351 210 9318 3767
2. Liviu Chircu (@liviuchircu) 352 211 9352 3810
3. Bogdan-Andrei Iancu (@bogdan-iancu) 245 150 4232 3624
4. Vlad Patrascu (@rvlad-patrascu) 43 25 794 661
5. Ionut Ionita (@ionutrazvanionita) 41 24 1099 413
Expand Down Expand Up @@ -1744,16 +1744,16 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Gang Zhuo Nov 2024 - Nov 2024
2. Alexandra Titoc Sep 2024 - Sep 2024
3. Carsten Bock Mar 2024 - Mar 2024
4. Maksym Sobolyev (@sobomax) Apr 2003 - Dec 2023
5. Vlad Paiu (@vladpaiu) Jun 2011 - Jul 2023
6. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - Mar 2023
7. Razvan Crainea (@razvancrainea) Jul 2011 - Jan 2023
8. Bogdan-Andrei Iancu (@bogdan-iancu) Mar 2002 - Feb 2022
9. Walter Doekes (@wdoekes) Apr 2019 - May 2021
10. Liviu Chircu (@liviuchircu) Jan 2013 - Apr 2021
1. Liviu Chircu (@liviuchircu) Jan 2013 - Nov 2024
2. Gang Zhuo Nov 2024 - Nov 2024
3. Alexandra Titoc Sep 2024 - Sep 2024
4. Carsten Bock Mar 2024 - Mar 2024
5. Maksym Sobolyev (@sobomax) Apr 2003 - Dec 2023
6. Vlad Paiu (@vladpaiu) Jun 2011 - Jul 2023
7. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - Mar 2023
8. Razvan Crainea (@razvancrainea) Jul 2011 - Jan 2023
9. Bogdan-Andrei Iancu (@bogdan-iancu) Mar 2002 - Feb 2022
10. Walter Doekes (@wdoekes) Apr 2019 - May 2021

All remaining contributors: Zero King (@l2dy), Peter Lemenkov
(@lemenkov), Alexey Vasilyev (@vasilevalex), Aron Podrigal
Expand Down
34 changes: 17 additions & 17 deletions modules/usrloc/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@
<row>
<entry>2. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">351</entry>
<entry align="center">210</entry>
<entry align="center">9318</entry>
<entry align="center">3767</entry>
<entry align="center">352</entry>
<entry align="center">211</entry>
<entry align="center">9352</entry>
<entry align="center">3810</entry>
</row>
<row>
<entry>3. </entry>
Expand Down Expand Up @@ -128,54 +128,54 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jan 2013 - Nov 2024</entry>
</row>
<row>
<entry>2. </entry>
<entry>Gang Zhuo</entry>
<entry align="center">Nov 2024 - Nov 2024</entry>
</row>
<row>
<entry>2. </entry>
<entry>3. </entry>
<entry>Alexandra Titoc</entry>
<entry align="center">Sep 2024 - Sep 2024</entry>
</row>
<row>
<entry>3. </entry>
<entry>4. </entry>
<entry>Carsten Bock</entry>
<entry align="center">Mar 2024 - Mar 2024</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Apr 2003 - Dec 2023</entry>
</row>
<row>
<entry>5. </entry>
<entry>6. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">Jun 2011 - Jul 2023</entry>
</row>
<row>
<entry>6. </entry>
<entry>7. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">Jul 2016 - Mar 2023</entry>
</row>
<row>
<entry>7. </entry>
<entry>8. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Jul 2011 - Jan 2023</entry>
</row>
<row>
<entry>8. </entry>
<entry>9. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Mar 2002 - Feb 2022</entry>
</row>
<row>
<entry>9. </entry>
<entry>10. </entry>
<entry>Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>)</entry>
<entry align="center">Apr 2019 - May 2021</entry>
</row>
<row>
<entry>10. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jan 2013 - Apr 2021</entry>
</row>
</tbody>
</tgroup>
</table>
Expand Down

0 comments on commit cc6c368

Please sign in to comment.