Rebuild documentation

OpenSIPS · Jan 20, 2019 · 6794a66 · 6794a66
1 parent 6250ee3
commit 6794a66
Show file tree

Hide file tree

Showing 12 changed files with 178 additions and 120 deletions.
diff --git a/modules/clusterer/README b/modules/clusterer/README
@@ -1132,9 +1132,9 @@ Chapter 3. Contributors
      Name DevScore Commits Lines ++ Lines --
    1. Vlad Patrascu (@rvlad-patrascu) 218 69 8913 4396
    2. Eseanu Marius Cristian (@eseanucristian) 45 10 3142 534
-   3. Liviu Chircu (@liviuchircu) 34 23 483 377
+   3. Liviu Chircu (@liviuchircu) 35 24 485 378
    4. Bogdan-Andrei Iancu (@bogdan-iancu) 19 8 1114 101
-   5. Razvan Crainea (@razvancrainea) 17 11 298 132
+   5. Razvan Crainea (@razvancrainea) 18 12 306 132
    6. Ionel Cerghit (@ionel-cerghit) 8 2 250 212
    7. Fabian Gast 3 1 1 1
    8. Peter Lemenkov (@lemenkov) 3 1 1 1
@@ -1160,10 +1160,10 @@ Chapter 3. Contributors
    Table 3.2. Most recently active contributors^(1) to this module
                         Name                     Commit Activity
    1. Razvan Crainea (@razvancrainea)          Nov 2015 - Jan 2019
-   2. Bogdan-Andrei Iancu (@bogdan-iancu)      Apr 2016 - Jan 2019
-   3. Vlad Patrascu (@rvlad-patrascu)          Jul 2016 - Dec 2018
-   4. Fabian Gast                              Nov 2018 - Nov 2018
-   5. Liviu Chircu (@liviuchircu)              Mar 2016 - Oct 2018
+   2. Liviu Chircu (@liviuchircu)              Mar 2016 - Jan 2019
+   3. Bogdan-Andrei Iancu (@bogdan-iancu)      Apr 2016 - Jan 2019
+   4. Vlad Patrascu (@rvlad-patrascu)          Jul 2016 - Dec 2018
+   5. Fabian Gast                              Nov 2018 - Nov 2018
    6. Peter Lemenkov (@lemenkov)               Jun 2018 - Jun 2018
    7. Ionel Cerghit (@ionel-cerghit)           Dec 2016 - Dec 2016
    8. Eseanu Marius Cristian (@eseanucristian) Jul 2015 - Sep 2015

diff --git a/modules/clusterer/doc/contributors.xml b/modules/clusterer/doc/contributors.xml
@@ -37,10 +37,10 @@
 	<row>
 		<entry>3. </entry>
 		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
-		<entry align="center">34</entry>
-		<entry align="center">23</entry>
-		<entry align="center">483</entry>
-		<entry align="center">377</entry>
+		<entry align="center">35</entry>
+		<entry align="center">24</entry>
+		<entry align="center">485</entry>
+		<entry align="center">378</entry>
 	</row>
 	<row>
 		<entry>4. </entry>
@@ -53,9 +53,9 @@
 	<row>
 		<entry>5. </entry>
 		<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
-		<entry align="center">17</entry>
-		<entry align="center">11</entry>
-		<entry align="center">298</entry>
+		<entry align="center">18</entry>
+		<entry align="center">12</entry>
+		<entry align="center">306</entry>
 		<entry align="center">132</entry>
 	</row>
 	<row>
@@ -117,24 +117,24 @@
 	</row>
 	<row>
 		<entry>2. </entry>
+		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
+		<entry align="center">Mar 2016 - Jan 2019</entry>
+	</row>
+	<row>
+		<entry>3. </entry>
 		<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
 		<entry align="center">Apr 2016 - Jan 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">Jul 2016 - Dec 2018</entry>
 	</row>
 	<row>
-		<entry>4. </entry>
+		<entry>5. </entry>
 		<entry>Fabian Gast</entry>
 		<entry align="center">Nov 2018 - Nov 2018</entry>
 	</row>
-	<row>
-		<entry>5. </entry>
-		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
-		<entry align="center">Mar 2016 - Oct 2018</entry>
-	</row>
 	<row>
 		<entry>6. </entry>
 		<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>

diff --git a/modules/mid_registrar/README b/modules/mid_registrar/README
@@ -41,8 +41,8 @@ mid_registrar Module
 
         1.6. Exported Functions
 
-              1.6.1. mid_registrar_save(domain[, [flags][, [aor][,
-                      [outgoing_expires]]]])
+              1.6.1. mid_registrar_save(domain[, flags[, aor[,
+                      outgoing_expires[, ownership_tag]]]])
 
               1.6.2. mid_registrar_lookup(domain[, [flags][,
                       [aor]]])
@@ -542,8 +542,8 @@ modparam("mid_registrar", "gruu_secret", "my_secret")
 
 1.6. Exported Functions
 
-1.6.1.  mid_registrar_save(domain[, [flags][, [aor][,
-[outgoing_expires]]]])
+1.6.1.  mid_registrar_save(domain[, flags[, aor[, outgoing_expires[,
+ownership_tag]]]])
 
    Function to be called when handling REGISTER requests. This
    function decides if a REGISTER should be forwarded to the main
@@ -610,6 +610,16 @@ modparam("mid_registrar", "gruu_secret", "my_secret")
        throttling modes) - custom value for the contact expiration
        interval of the outgoing REGISTER request, which overrides
        the default outgoing_expires module parameter.
+     * ownership_tag (optional) - a cluster-shared tag (see the
+       clusterer module documentation for more details) which will
+       be attached to each contact saved from the current request.
+       This tag is only relevant in clustered user location
+       scenarios and helps determine the current logical owner
+       node of a contact. This, in turn, is useful in order to
+       restrict nodes which are not currently responsible for this
+       contact from performing certain actions (for example:
+       incorrectly originating pings from a non-owned virtual IP
+       address in highly-available setups).
 
    Return value
      * 1 (success) - current REGISTER request must be dispatched
@@ -771,7 +781,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) 384 113 14631 8713
+   1. Liviu Chircu (@liviuchircu) 388 115 14688 8728
    2. Chad Attermann (@attermann) 7 5 19 5
    3. Razvan Crainea (@razvancrainea) 5 3 16 13
    4. Bogdan-Andrei Iancu (@bogdan-iancu) 3 1 2 2

diff --git a/modules/mid_registrar/doc/contributors.xml b/modules/mid_registrar/doc/contributors.xml
@@ -21,10 +21,10 @@
 	<row>
 		<entry>1. </entry>
 		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
-		<entry align="center">384</entry>
-		<entry align="center">113</entry>
-		<entry align="center">14631</entry>
-		<entry align="center">8713</entry>
+		<entry align="center">388</entry>
+		<entry align="center">115</entry>
+		<entry align="center">14688</entry>
+		<entry align="center">8728</entry>
 	</row>
 	<row>
 		<entry>2. </entry>

diff --git a/modules/nathelper/README b/modules/nathelper/README
@@ -651,7 +651,7 @@ Chapter 3. Contributors
    1. Maksym Sobolyev (@sobomax) 153 39 3533 4766
    2. Bogdan-Andrei Iancu (@bogdan-iancu) 144 113 2012 793
    3. Ionut Ionita (@ionutrazvanionita) 40 15 1598 627
-   4. Liviu Chircu (@liviuchircu) 36 27 386 249
+   4. Liviu Chircu (@liviuchircu) 37 28 387 250
    5. Razvan Crainea (@razvancrainea) 29 22 143 236
    6. Daniel-Constantin Mierla (@miconda) 22 17 142 124
    7. Jan Janak (@janakj) 21 11 780 129
@@ -689,8 +689,8 @@ Chapter 3. Contributors
 
    Table 3.2. Most recently active contributors^(1) to this module
                       Name                   Commit Activity
-   1.  Bogdan-Andrei Iancu (@bogdan-iancu) Nov 2003 - Jan 2019
-   2.  Liviu Chircu (@liviuchircu)         Jan 2013 - Aug 2018
+   1.  Liviu Chircu (@liviuchircu)         Jan 2013 - Jan 2019
+   2.  Bogdan-Andrei Iancu (@bogdan-iancu) Nov 2003 - Jan 2019
    3.  Razvan Crainea (@razvancrainea)     Dec 2010 - Jul 2018
    4.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
    5.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - May 2018

diff --git a/modules/nathelper/doc/contributors.xml b/modules/nathelper/doc/contributors.xml
@@ -45,10 +45,10 @@
 	<row>
 		<entry>4. </entry>
 		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
-		<entry align="center">36</entry>
-		<entry align="center">27</entry>
-		<entry align="center">386</entry>
-		<entry align="center">249</entry>
+		<entry align="center">37</entry>
+		<entry align="center">28</entry>
+		<entry align="center">387</entry>
+		<entry align="center">250</entry>
 	</row>
 	<row>
 		<entry>5. </entry>
@@ -128,13 +128,13 @@
 	<tbody>
 	<row>
 		<entry>1. </entry>
-		<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
-		<entry align="center">Nov 2003 - Jan 2019</entry>
+		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
+		<entry align="center">Jan 2013 - Jan 2019</entry>
 	</row>
 	<row>
 		<entry>2. </entry>
-		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
-		<entry align="center">Jan 2013 - Aug 2018</entry>
+		<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
+		<entry align="center">Nov 2003 - Jan 2019</entry>
 	</row>
 	<row>
 		<entry>3. </entry>

diff --git a/modules/pua_dialoginfo/README b/modules/pua_dialoginfo/README
@@ -498,7 +498,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. Bogdan-Andrei Iancu (@bogdan-iancu) 38 19 863 647
+   1. Bogdan-Andrei Iancu (@bogdan-iancu) 41 21 980 655
    2. Anca Vamanu 27 16 713 231
    3. Liviu Chircu (@liviuchircu) 12 9 44 76
    4. Klaus Darilion 10 1 1109 0
@@ -510,7 +510,7 @@ Chapter 2. Contributors
    10. Walter Doekes (@wdoekes) 4 2 19 8
 
    All remaining contributors: Stanislaw Pitucha, Vlad Patrascu
-   (@rvlad-patrascu), Peter Lemenkov (@lemenkov).
+   (@rvlad-patrascu), Peter Lemenkov (@lemenkov), Aron Podrigal.
 
    (1) DevScore = author_commits + author_lines_added /
    (project_lines_added / project_commits) + author_lines_deleted
@@ -533,18 +533,18 @@ Chapter 2. Contributors
    Table 2.2. Most recently active contributors^(1) to this module
                       Name                   Commit Activity
    1.  Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2009 - Jan 2019
-   2.  Liviu Chircu (@liviuchircu)         Mar 2014 - Nov 2018
-   3.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
-   4.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Jul 2017
-   5.  Razvan Crainea (@razvancrainea)     Feb 2012 - Apr 2017
-   6.  Ovidiu Sas (@ovidiusas)             Sep 2010 - Jan 2014
-   7.  Damien Sandras (@dsandras)          Jul 2013 - Aug 2013
-   8.  Vlad Paiu (@vladpaiu)               Aug 2011 - Aug 2011
-   9.  Anca Vamanu                         Jul 2009 - Mar 2011
-   10. Vallimamod Abdullah                 Oct 2010 - Jan 2011
-
-   All remaining contributors: Stanislaw Pitucha, Walter Doekes
-   (@wdoekes), Klaus Darilion.
+   2.  Aron Podrigal                       Jan 2019 - Jan 2019
+   3.  Liviu Chircu (@liviuchircu)         Mar 2014 - Nov 2018
+   4.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
+   5.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Jul 2017
+   6.  Razvan Crainea (@razvancrainea)     Feb 2012 - Apr 2017
+   7.  Ovidiu Sas (@ovidiusas)             Sep 2010 - Jan 2014
+   8.  Damien Sandras (@dsandras)          Jul 2013 - Aug 2013
+   9.  Vlad Paiu (@vladpaiu)               Aug 2011 - Aug 2011
+   10. Anca Vamanu                         Jul 2009 - Mar 2011
+
+   All remaining contributors: Vallimamod Abdullah, Stanislaw
+   Pitucha, Walter Doekes (@wdoekes), Klaus Darilion.
 
    (1) including any documentation-related commits, excluding
    merge commits

diff --git a/modules/pua_dialoginfo/doc/contributors.xml b/modules/pua_dialoginfo/doc/contributors.xml
@@ -21,10 +21,10 @@
 	<row>
 		<entry>1. </entry>
 		<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
-		<entry align="center">38</entry>
-		<entry align="center">19</entry>
-		<entry align="center">863</entry>
-		<entry align="center">647</entry>
+		<entry align="center">41</entry>
+		<entry align="center">21</entry>
+		<entry align="center">980</entry>
+		<entry align="center">655</entry>
 	</row>
 	<row>
 		<entry>2. </entry>
@@ -101,7 +101,7 @@
 	</tbody>
 	</tgroup>
 	</table>
-	<para><emphasis role='bold'>All remaining contributors</emphasis>: Stanislaw Pitucha, 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'>All remaining contributors</emphasis>: Stanislaw Pitucha, Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Aron Podrigal.</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>
@@ -133,53 +133,53 @@
 	</row>
 	<row>
 		<entry>2. </entry>
+		<entry>Aron Podrigal</entry>
+		<entry align="center">Jan 2019 - Jan 2019</entry>
+	</row>
+	<row>
+		<entry>3. </entry>
 		<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
 		<entry align="center">Mar 2014 - Nov 2018</entry>
 	</row>
 	<row>
-		<entry>3. </entry>
+		<entry>4. </entry>
 		<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
 		<entry align="center">Jun 2018 - Jun 2018</entry>
 	</row>
 	<row>
-		<entry>4. </entry>
+		<entry>5. </entry>
 		<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
 		<entry align="center">May 2017 - Jul 2017</entry>
 	</row>
 	<row>
-		<entry>5. </entry>
+		<entry>6. </entry>
 		<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
 		<entry align="center">Feb 2012 - Apr 2017</entry>
 	</row>
 	<row>
-		<entry>6. </entry>
+		<entry>7. </entry>
 		<entry>Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>)</entry>
 		<entry align="center">Sep 2010 - Jan 2014</entry>
 	</row>
 	<row>
-		<entry>7. </entry>
+		<entry>8. </entry>
 		<entry>Damien Sandras (<ulink url="https://github.com/dsandras">@dsandras</ulink>)</entry>
 		<entry align="center">Jul 2013 - Aug 2013</entry>
 	</row>
 	<row>
-		<entry>8. </entry>
+		<entry>9. </entry>
 		<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
 		<entry align="center">Aug 2011 - Aug 2011</entry>
 	</row>
 	<row>
-		<entry>9. </entry>
+		<entry>10. </entry>
 		<entry>Anca Vamanu</entry>
 		<entry align="center">Jul 2009 - Mar 2011</entry>
 	</row>
-	<row>
-		<entry>10. </entry>
-		<entry>Vallimamod Abdullah</entry>
-		<entry align="center">Oct 2010 - Jan 2011</entry>
-	</row>
 	</tbody>
 	</tgroup>
 	</table>
-	<para><emphasis role='bold'>All remaining contributors</emphasis>: Stanislaw Pitucha, Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Klaus Darilion.</para>
+	<para><emphasis role='bold'>All remaining contributors</emphasis>: Vallimamod Abdullah, Stanislaw Pitucha, Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Klaus Darilion.</para>
 	<para>
 	    <emphasis>(1) including any documentation-related commits, excluding merge commits</emphasis>
 	</para>