Skip to content

Commit

Permalink
Rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@opensips-github @razvancrainea
opensips-github authored and razvancrainea committed Feb 11, 2020
1 parent 5f6710c commit 57e9aff
Show file tree
Hide file tree
Showing 18 changed files with 218 additions and 147 deletions.
6 changes: 3 additions & 3 deletions modules/b2b_entities/README
View file
Expand Up @@ -449,7 +449,7 @@ Chapter 3. Contributors
3. Bogdan-Andrei Iancu (@bogdan-iancu) 44 38 307 121
4. Razvan Crainea (@razvancrainea) 26 23 90 66
5. Liviu Chircu (@liviuchircu) 14 10 72 114
6. Vlad Patrascu (@rvlad-patrascu) 10 5 174 151
6. Vlad Patrascu (@rvlad-patrascu) 11 6 177 154
7. Vlad Paiu (@vladpaiu) 6 4 74 47
8. Stanislaw Pitucha 4 2 6 6
9. Nick Altmann (@nikbyte) 4 1 157 26
Expand Down Expand Up @@ -479,8 +479,8 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Razvan Crainea (@razvancrainea) Dec 2010 - Nov 2019
2. Vlad Patrascu (@rvlad-patrascu) May 2017 - Jul 2019
1. Vlad Patrascu (@rvlad-patrascu) May 2017 - Feb 2020
2. Razvan Crainea (@razvancrainea) Dec 2010 - Nov 2019
3. Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Jun 2019
4. Liviu Chircu (@liviuchircu) Mar 2014 - Nov 2018
5. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
Expand Down
16 changes: 8 additions & 8 deletions modules/b2b_entities/doc/contributors.xml
View file
Expand Up @@ -61,10 +61,10 @@
<row>
<entry>6. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">10</entry>
<entry align="center">5</entry>
<entry align="center">174</entry>
<entry align="center">151</entry>
<entry align="center">11</entry>
<entry align="center">6</entry>
<entry align="center">177</entry>
<entry align="center">154</entry>
</row>
<row>
<entry>7. </entry>
Expand Down Expand Up @@ -128,13 +128,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Dec 2010 - Nov 2019</entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Feb 2020</entry>
</row>
<row>
<entry>2. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Jul 2019</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Dec 2010 - Nov 2019</entry>
</row>
<row>
<entry>3. </entry>
Expand Down
10 changes: 5 additions & 5 deletions modules/drouting/README
View file
Expand Up @@ -1615,7 +1615,7 @@ Chapter 3. Contributors
Name DevScore Commits Lines ++ Lines --
1. Bogdan-Andrei Iancu (@bogdan-iancu) 371 171 12770 5536
2. Razvan Crainea (@razvancrainea) 92 44 1113 2144
3. Liviu Chircu (@liviuchircu) 50 33 855 533
3. Liviu Chircu (@liviuchircu) 51 34 858 536
4. Mihai Tiganus (@tallicamike) 48 10 3130 710
5. Vlad Patrascu (@rvlad-patrascu) 40 17 1090 728
6. Vlad Paiu (@vladpaiu) 23 20 244 47
Expand Down Expand Up @@ -1650,10 +1650,10 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Razvan Crainea (@razvancrainea) Sep 2010 - Jan 2020
2. Vlad Patrascu (@rvlad-patrascu) Mar 2017 - Jan 2020
3. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2008 - Dec 2019
4. Liviu Chircu (@liviuchircu) Nov 2012 - Nov 2018
1. Liviu Chircu (@liviuchircu) Nov 2012 - Feb 2020
2. Razvan Crainea (@razvancrainea) Sep 2010 - Jan 2020
3. Vlad Patrascu (@rvlad-patrascu) Mar 2017 - Jan 2020
4. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2008 - Dec 2019
5. Vlad Paiu (@vladpaiu) Aug 2011 - Nov 2018
6. Alexey Vasilyev (@vasilevalex) Oct 2018 - Oct 2018
7. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
Expand Down
22 changes: 11 additions & 11 deletions modules/drouting/doc/contributors.xml
View file
Expand Up @@ -37,10 +37,10 @@
<row>
<entry>3. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">50</entry>
<entry align="center">33</entry>
<entry align="center">855</entry>
<entry align="center">533</entry>
<entry align="center">51</entry>
<entry align="center">34</entry>
<entry align="center">858</entry>
<entry align="center">536</entry>
</row>
<row>
<entry>4. </entry>
Expand Down Expand Up @@ -128,24 +128,24 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Nov 2012 - Feb 2020</entry>
</row>
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Sep 2010 - Jan 2020</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">Mar 2017 - Jan 2020</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 2008 - Dec 2019</entry>
</row>
<row>
<entry>4. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Nov 2012 - Nov 2018</entry>
</row>
<row>
<entry>5. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
Expand Down
75 changes: 55 additions & 20 deletions modules/mid_registrar/README
View file
Expand Up @@ -36,9 +36,12 @@ mid_registrar Module
1.5.14. realm_prefix (string)
1.5.15. case_sensitive (integer)
1.5.16. max_contacts (integer)
1.5.17. retry_after (integer)
1.5.18. disable_gruu (integer)
1.5.19. gruu_secret (string)
1.5.17. max_username_len (integer)
1.5.18. max_domain_len (integer)
1.5.19. max_aor_len (integer)
1.5.20. retry_after (integer)
1.5.21. disable_gruu (integer)
1.5.22. gruu_secret (string)

1.6. Exported Functions

Expand Down Expand Up @@ -82,11 +85,14 @@ mid_registrar Module
1.14. Setting the realm_prefix module parameter
1.15. Setting the case_sensitive module parameter
1.16. Setting the max_contacts module parameter
1.17. Setting the retry_after module parameter
1.18. Setting the gruu_secret module parameter
1.19. Setting the gruu_secret module parameter
1.20. mid_registrar_save usage
1.21. mid_registrar_lookup usage
1.17. Setting the max_username_len module parameter
1.18. Setting the max_domain_len module parameter
1.19. Setting the max_aor_len module parameter
1.20. Setting the retry_after module parameter
1.21. Setting the gruu_secret module parameter
1.22. Setting the gruu_secret module parameter
1.23. mid_registrar_save usage
1.24. mid_registrar_lookup usage

Chapter 1. Admin Guide

Expand Down Expand Up @@ -540,7 +546,36 @@ modparam("mid_registrar", "case_sensitive", 0)
Example 1.16. Setting the max_contacts module parameter
modparam("mid_registrar", "max_contacts", 10)

1.5.17. retry_after (integer)
1.5.17. max_username_len (integer)

The maximum length of the "username" part of an
Address-of-Record SIP URI.

Default value is 64.

Example 1.17. Setting the max_username_len module parameter
modparam("mid_registrar", "max_username_len", 128)

1.5.18. max_domain_len (integer)

The maximum length of the "domain" part of an Address-of-Record
SIP URI.

Default value is 64.

Example 1.18. Setting the max_domain_len module parameter
modparam("mid_registrar", "max_domain_len", 128)

1.5.19. max_aor_len (integer)

The maximum length of an Address-of-Record SIP URI.

Default value is 256.

Example 1.19. Setting the max_aor_len module parameter
modparam("mid_registrar", "max_aor_len", 512)

1.5.20. retry_after (integer)

The mid-registrar can generate 5xx replies to registrations in
various situations. It could, for example, happen when the
Expand All @@ -555,26 +590,26 @@ modparam("mid_registrar", "max_contacts", 10)

Default value is 0 (disabled)

Example 1.17. Setting the retry_after module parameter
Example 1.20. Setting the retry_after module parameter
modparam("mid_registrar", "retry_after", 30)

1.5.18. disable_gruu (integer)
1.5.21. disable_gruu (integer)

Globally disable GRUU handling.

Default value is 1 (GRUUs will not be handled)

Example 1.18. Setting the gruu_secret module parameter
Example 1.21. Setting the gruu_secret module parameter
modparam("mid_registrar", "disable_gruu", 0)

1.5.19. gruu_secret (string)
1.5.22. gruu_secret (string)

The string that will be used in XORing when generating
temporary GRUUs.

Default value is "0p3nS1pS"

Example 1.19. Setting the gruu_secret module parameter
Example 1.22. Setting the gruu_secret module parameter
modparam("mid_registrar", "gruu_secret", "my_secret")

1.6. Exported Functions
Expand Down Expand Up @@ -708,7 +743,7 @@ ownership_tag]]]])

This function can only be used from the request route.

Example 1.20. mid_registrar_save usage
Example 1.23. mid_registrar_save usage
...
if (is_method("REGISTER")) {
mid_registrar_save("location");
Expand Down Expand Up @@ -836,7 +871,7 @@ if (is_method("REGISTER")) {

This function can only be used from the request route.

Example 1.21. mid_registrar_lookup usage
Example 1.24. mid_registrar_lookup usage
...
# initial invites from the main registrar - need to look them up
!
Expand All @@ -860,7 +895,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) 412 133 15289 8852
1. Liviu Chircu (@liviuchircu) 418 135 15361 9006
2. Vlad Patrascu (@rvlad-patrascu) 9 5 74 126
3. Razvan Crainea (@razvancrainea) 8 6 19 14
4. Bogdan-Andrei Iancu (@bogdan-iancu) 8 5 100 109
Expand Down Expand Up @@ -889,7 +924,7 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Jul 2016 - Jan 2020
1. Liviu Chircu (@liviuchircu) Jul 2016 - Feb 2020
2. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2017 - Nov 2019
3. Razvan Crainea (@razvancrainea) Mar 2017 - Sep 2019
4. Dan Pascu (@danpascu) May 2019 - May 2019
Expand All @@ -905,8 +940,8 @@ Chapter 3. Documentation

3.1. Contributors

Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Liviu
Chircu (@liviuchircu), Vlad Patrascu (@rvlad-patrascu), Peter
Last edited by: Liviu Chircu (@liviuchircu), Bogdan-Andrei
Iancu (@bogdan-iancu), Vlad Patrascu (@rvlad-patrascu), Peter
Lemenkov (@lemenkov).

Documentation Copyrights:
Expand Down
12 changes: 6 additions & 6 deletions modules/mid_registrar/doc/contributors.xml
View file
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">412</entry>
<entry align="center">133</entry>
<entry align="center">15289</entry>
<entry align="center">8852</entry>
<entry align="center">418</entry>
<entry align="center">135</entry>
<entry align="center">15361</entry>
<entry align="center">9006</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -113,7 +113,7 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jul 2016 - Jan 2020</entry>
<entry align="center">Jul 2016 - Feb 2020</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -164,7 +164,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>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>).</para>
<para><emphasis role='bold'>Last edited by:</emphasis> Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), 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>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>).</para>
</section>

</chapter>
6 changes: 3 additions & 3 deletions modules/proto_ws/README
View file
Expand Up @@ -274,7 +274,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. Razvan Crainea (@razvancrainea) 82 39 3907 633
1. Razvan Crainea (@razvancrainea) 87 40 3991 797
2. Ionut Ionita (@ionutrazvanionita) 22 14 609 114
3. Bogdan-Andrei Iancu (@bogdan-iancu) 13 11 104 19
4. Liviu Chircu (@liviuchircu) 11 8 67 93
Expand Down Expand Up @@ -304,8 +304,8 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Mar 2015 - Jan 2020
2. Razvan Crainea (@razvancrainea) Mar 2015 - Jan 2020
1. Razvan Crainea (@razvancrainea) Mar 2015 - Feb 2020
2. Liviu Chircu (@liviuchircu) Mar 2015 - Jan 2020
3. Bogdan-Andrei Iancu (@bogdan-iancu) Mar 2017 - May 2019
4. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019
5. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
Expand Down
14 changes: 7 additions & 7 deletions modules/proto_ws/doc/contributors.xml
View file
Expand Up @@ -21,10 +21,10 @@
<row>
<entry>1. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">82</entry>
<entry align="center">39</entry>
<entry align="center">3907</entry>
<entry align="center">633</entry>
<entry align="center">87</entry>
<entry align="center">40</entry>
<entry align="center">3991</entry>
<entry align="center">797</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -120,12 +120,12 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2015 - Jan 2020</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Mar 2015 - Feb 2020</entry>
</row>
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2015 - Jan 2020</entry>
</row>
<row>
Expand Down
8 changes: 4 additions & 4 deletions modules/proto_wss/README
View file
Expand Up @@ -356,7 +356,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. Razvan Crainea (@razvancrainea) 21 14 756 39
1. Razvan Crainea (@razvancrainea) 24 15 756 121
2. Bogdan-Andrei Iancu (@bogdan-iancu) 14 11 228 13
3. Ionut Ionita (@ionutrazvanionita) 14 10 362 19
4. Vlad Patrascu (@rvlad-patrascu) 8 6 51 41
Expand Down Expand Up @@ -385,9 +385,9 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Mar 2016 - Jan 2020
2. Dan Pascu (@danpascu) Jan 2020 - Jan 2020
3. Razvan Crainea (@razvancrainea) Jan 2016 - Jan 2020
1. Razvan Crainea (@razvancrainea) Jan 2016 - Feb 2020
2. Liviu Chircu (@liviuchircu) Mar 2016 - Jan 2020
3. Dan Pascu (@danpascu) Jan 2020 - Jan 2020
4. Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2016 - May 2019
5. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019
6. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
Expand Down

0 comments on commit 57e9aff

Please sign in to comment.