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 Mar 30, 2024
1 parent 7428704 commit 03f3f0c
Show file tree
Hide file tree
Showing 16 changed files with 524 additions and 162 deletions.
6 changes: 3 additions & 3 deletions modules/aaa_diameter/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ Chapter 2. Contributors
Table 2.1. Top contributors by DevScore^(1), authored
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Liviu Chircu (@liviuchircu) 111 36 6848 1103
1. Liviu Chircu (@liviuchircu) 112 37 6850 1105
2. Razvan Crainea (@razvancrainea) 34 17 1360 246
3. Maksym Sobolyev (@sobomax) 3 1 5 5

Expand All @@ -484,8 +484,8 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Razvan Crainea (@razvancrainea) May 2023 - Mar 2024
2. Liviu Chircu (@liviuchircu) May 2021 - Mar 2024
1. Liviu Chircu (@liviuchircu) May 2021 - Mar 2024
2. Razvan Crainea (@razvancrainea) May 2023 - Mar 2024
3. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023

(1) including any documentation-related commits, excluding
Expand Down
16 changes: 8 additions & 8 deletions modules/aaa_diameter/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">111</entry>
<entry align="center">36</entry>
<entry align="center">6848</entry>
<entry align="center">1103</entry>
<entry align="center">112</entry>
<entry align="center">37</entry>
<entry align="center">6850</entry>
<entry align="center">1105</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -72,13 +72,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">May 2023 - Mar 2024</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">May 2021 - Mar 2024</entry>
</row>
<row>
<entry>2. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">May 2021 - Mar 2024</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">May 2023 - Mar 2024</entry>
</row>
<row>
<entry>3. </entry>
Expand Down
95 changes: 56 additions & 39 deletions modules/clusterer/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ CLUSTERER Module
1.4.23. flags_col
1.4.24. description_col
1.4.25. enable_stats (integer)
1.4.26. enable_rerouting (integer)

1.5. Exported Functions

Expand Down Expand Up @@ -149,16 +150,17 @@ CLUSTERER Module
1.23. Set flags_col parameter
1.24. Set description_col parameter
1.25. Set enable_stats parameter
1.26. cluster_send_req() usage
1.27. cluster_send_rpl() usage
1.28. cluster_broadcast_req() usage
1.29. cluster_check_addr() usage
1.30. clusterer_list usage
1.31. clusterer_list_topology usage
1.32. clusterer_list_cap usage
1.33. Example database content - clusterer table
1.34. Node A configuration
1.35. Node B configuration
1.26. Set enable_rerouting parameter
1.27. cluster_send_req() usage
1.28. cluster_send_rpl() usage
1.29. cluster_broadcast_req() usage
1.30. cluster_check_addr() usage
1.31. clusterer_list usage
1.32. clusterer_list_topology usage
1.33. clusterer_list_cap usage
1.34. Example database content - clusterer table
1.35. Node A configuration
1.36. Node B configuration

Chapter 1. Admin Guide

Expand Down Expand Up @@ -600,6 +602,20 @@ modparam("clusterer", "description_col", "description")
modparam("clusterer", "enable_stats", 0)
...

1.4.26. enable_rerouting (integer)

If packets should be rerouted via another node if a direct
route to destination is unavailible. Disabling may improve
stability in two-node topologies. Set it to zero to disable or
to non-zero to enable it.

Default value is “1 (enabled)”.

Example 1.26. Set enable_rerouting parameter
...
modparam("clusterer", "enable_rerouting", 0)
...

1.5. Exported Functions

1.5.1. cluster_send_req(cluster_id, dst_id, msg, [tag])
Expand Down Expand Up @@ -632,7 +648,7 @@ modparam("clusterer", "enable_stats", 0)
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE.

Example 1.26. cluster_send_req() usage
Example 1.27. cluster_send_req() usage
...
# send a request
cluster_send_req(1, 1, "Check USER: $fU", $var(req_tag));
Expand Down Expand Up @@ -676,7 +692,7 @@ route[rpl_resume] {
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE.

Example 1.27. cluster_send_rpl() usage
Example 1.28. cluster_send_rpl() usage
...
event_route[E_CLUSTERER_REQ_RECEIVED] {
cluster_send_rpl($param(cluster_id), $param(src_id), $var(my_reply), $
Expand Down Expand Up @@ -704,7 +720,7 @@ param(tag));
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE.

Example 1.28. cluster_broadcast_req() usage
Example 1.29. cluster_broadcast_req() usage
...
cluster_broadcast_req($var(cl_id), $var(share_data));
...
Expand All @@ -726,7 +742,7 @@ cluster_broadcast_req($var(cl_id), $var(share_data));
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and EVENT_ROUTE.

Example 1.29. cluster_check_addr() usage
Example 1.30. cluster_check_addr() usage
...
if (cluster_check_addr(1, $si)) {
...
Expand Down Expand Up @@ -757,7 +773,7 @@ if (cluster_check_addr(1, $si)) {

Parameters:none

Example 1.30. clusterer_list usage
Example 1.31. clusterer_list usage
$ opensips-cli -x mi clusterer_list
{
"Clusters": [
Expand Down Expand Up @@ -791,7 +807,7 @@ $ opensips-cli -x mi clusterer_list

Parameters:none

Example 1.31. clusterer_list_topology usage
Example 1.32. clusterer_list_topology usage
$ opensips-cli -x mi clusterer_list_topology
{
"Clusters": [
Expand Down Expand Up @@ -908,7 +924,7 @@ opensips-cli -x mi cluster_broadcast_mi 1 dr_reload partition_5

Parameters:none

Example 1.32. clusterer_list_cap usage
Example 1.33. clusterer_list_cap usage
$ opensips-cli -x mi clusterer_list_cap
{
"Clusters": [
Expand Down Expand Up @@ -1178,7 +1194,7 @@ oadcast from 2"

We insert in the the clusterer table the following:

Example 1.33. Example database content - clusterer table
Example 1.34. Example database content - clusterer table
+----+------------+---------+----------------------+-------+------------
-----+----------+----------+-------+-------------+
| id | cluster_id | node_id | url | state | no_ping_ret
Expand Down Expand Up @@ -1221,7 +1237,7 @@ ries | priority | sip_addr | flags | description |
configure the two instances of OpenSIPS. First, we configure
Node A:

Example 1.34. Node A configuration
Example 1.35. Node A configuration
...
socket= bin:192.168.0.5:5566 # bin listener for Node A

Expand All @@ -1237,7 +1253,7 @@ modparam("ratelimit", "pipe_replication_cluster", 1)

Similarly, the configuration for Node B is as follows:

Example 1.35. Node B configuration
Example 1.36. Node B configuration
...
socket= bin:192.168.0.6:5566 # bin listener for Node B

Expand Down Expand Up @@ -1444,7 +1460,7 @@ Chapter 3. Contributors
10. Gohar Ahmed (@goharahmed) 3 1 6 5

All remaining contributors: kworm83, Peter Lemenkov
(@lemenkov).
(@lemenkov), Shanee Vanstone.

(1) DevScore = author_commits + author_lines_added /
(project_lines_added / project_commits) + author_lines_deleted
Expand All @@ -1466,19 +1482,20 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Maksym Sobolyev (@sobomax) Jan 2021 - Nov 2023
2. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - Jul 2023
3. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2016 - Apr 2023
4. Liviu Chircu (@liviuchircu) Mar 2016 - Oct 2022
5. Razvan Crainea (@razvancrainea) Nov 2015 - Aug 2022
6. Jasper Hafkenscheid May 2022 - Jul 2022
7. kworm83 Feb 2021 - Feb 2021
8. Fabian Gast (@fgast) Nov 2018 - Jul 2020
9. Gohar Ahmed (@goharahmed) Mar 2019 - Mar 2019
10. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018

All remaining contributors: Ionel Cerghit (@ionel-cerghit),
Eseanu Marius Cristian (@eseanucristian).
1. Shanee Vanstone Mar 2024 - Mar 2024
2. Maksym Sobolyev (@sobomax) Jan 2021 - Nov 2023
3. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - Jul 2023
4. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2016 - Apr 2023
5. Liviu Chircu (@liviuchircu) Mar 2016 - Oct 2022
6. Razvan Crainea (@razvancrainea) Nov 2015 - Aug 2022
7. Jasper Hafkenscheid May 2022 - Jul 2022
8. kworm83 Feb 2021 - Feb 2021
9. Fabian Gast (@fgast) Nov 2018 - Jul 2020
10. Gohar Ahmed (@goharahmed) Mar 2019 - Mar 2019

All remaining contributors: Peter Lemenkov (@lemenkov), Ionel
Cerghit (@ionel-cerghit), Eseanu Marius Cristian
(@eseanucristian).

(1) including any documentation-related commits, excluding
merge commits
Expand All @@ -1487,11 +1504,11 @@ Chapter 4. Documentation

4.1. Contributors

Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Vlad
Patrascu (@rvlad-patrascu), Jasper Hafkenscheid, Liviu Chircu
(@liviuchircu), Fabian Gast (@fgast), Razvan Crainea
(@razvancrainea), Peter Lemenkov (@lemenkov), Eseanu Marius
Cristian (@eseanucristian).
Last edited by: Shanee Vanstone, Bogdan-Andrei Iancu
(@bogdan-iancu), Vlad Patrascu (@rvlad-patrascu), Jasper
Hafkenscheid, Liviu Chircu (@liviuchircu), Fabian Gast
(@fgast), Razvan Crainea (@razvancrainea), Peter Lemenkov
(@lemenkov), Eseanu Marius Cristian (@eseanucristian).

Documentation Copyrights:

Expand Down
32 changes: 16 additions & 16 deletions modules/clusterer/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>: kworm83, Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>).</para>
<para><emphasis role='bold'>All remaining contributors</emphasis>: kworm83, Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Shanee Vanstone.</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>Shanee Vanstone</entry>
<entry align="center">Mar 2024 - Mar 2024</entry>
</row>
<row>
<entry>2. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Jan 2021 - Nov 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>3. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">Jul 2016 - Jul 2023</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">Apr 2016 - Apr 2023</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2016 - Oct 2022</entry>
</row>
<row>
<entry>5. </entry>
<entry>6. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Nov 2015 - Aug 2022</entry>
</row>
<row>
<entry>6. </entry>
<entry>7. </entry>
<entry>Jasper Hafkenscheid</entry>
<entry align="center">May 2022 - Jul 2022</entry>
</row>
<row>
<entry>7. </entry>
<entry>8. </entry>
<entry>kworm83</entry>
<entry align="center">Feb 2021 - Feb 2021</entry>
</row>
<row>
<entry>8. </entry>
<entry>9. </entry>
<entry>Fabian Gast (<ulink url="https://github.com/fgast">@fgast</ulink>)</entry>
<entry align="center">Nov 2018 - Jul 2020</entry>
</row>
<row>
<entry>9. </entry>
<entry>10. </entry>
<entry>Gohar Ahmed (<ulink url="https://github.com/goharahmed">@goharahmed</ulink>)</entry>
<entry align="center">Mar 2019 - Mar 2019</entry>
</row>
<row>
<entry>10. </entry>
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
<entry align="center">Jun 2018 - Jun 2018</entry>
</row>
</tbody>
</tgroup>
</table>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Ionel Cerghit (<ulink url="https://github.com/ionel-cerghit">@ionel-cerghit</ulink>), Eseanu Marius Cristian (<ulink url="https://github.com/eseanucristian">@eseanucristian</ulink>).</para>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Ionel Cerghit (<ulink url="https://github.com/ionel-cerghit">@ionel-cerghit</ulink>), Eseanu Marius Cristian (<ulink url="https://github.com/eseanucristian">@eseanucristian</ulink>).</para>
<para>
<emphasis>(1) including any documentation-related commits, excluding merge commits</emphasis>
</para>
Expand All @@ -190,7 +190,7 @@
<title>Documentation</title>
<section id="documentation_contributors" xreflabel="documentation_contributors">
<title>Contributors</title>
<para><emphasis role='bold'>Last edited by:</emphasis> Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Jasper Hafkenscheid, Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Fabian Gast (<ulink url="https://github.com/fgast">@fgast</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Eseanu Marius Cristian (<ulink url="https://github.com/eseanucristian">@eseanucristian</ulink>).</para>
<para><emphasis role='bold'>Last edited by:</emphasis> Shanee Vanstone, Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Jasper Hafkenscheid, Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Fabian Gast (<ulink url="https://github.com/fgast">@fgast</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Eseanu Marius Cristian (<ulink url="https://github.com/eseanucristian">@eseanucristian</ulink>).</para>
</section>

</chapter>
12 changes: 6 additions & 6 deletions modules/drouting/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1894,7 +1894,7 @@ Chapter 3. Contributors
Table 3.1. Top contributors by DevScore^(1), authored
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Bogdan-Andrei Iancu (@bogdan-iancu) 408 200 13802 5820
1. Bogdan-Andrei Iancu (@bogdan-iancu) 410 201 13804 5822
2. Liviu Chircu (@liviuchircu) 156 92 2503 2608
3. Razvan Crainea (@razvancrainea) 100 53 1171 2226
4. Mihai Tiganus (@tallicamike) 71 20 4301 910
Expand Down Expand Up @@ -1933,11 +1933,11 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Vlad Paiu (@vladpaiu) Aug 2011 - Feb 2024
2. Liviu Chircu (@liviuchircu) Nov 2012 - Dec 2023
3. Maksym Sobolyev (@sobomax) Oct 2020 - Nov 2023
4. Razvan Crainea (@razvancrainea) Sep 2010 - Oct 2023
5. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2008 - May 2023
1. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2008 - Mar 2024
2. Vlad Paiu (@vladpaiu) Aug 2011 - Feb 2024
3. Liviu Chircu (@liviuchircu) Nov 2012 - Dec 2023
4. Maksym Sobolyev (@sobomax) Oct 2020 - Nov 2023
5. Razvan Crainea (@razvancrainea) Sep 2010 - Oct 2023
6. wangdd May 2023 - May 2023
7. MayamaTakeshi Apr 2023 - Apr 2023
8. nexbridge Feb 2023 - Mar 2023
Expand Down

0 comments on commit 03f3f0c

Please sign in to comment.