Skip to content

Commit ef44146

Browse files
opensips-githubopensips-github
committed
Rebuild documentation
1 parent 8ffe818 commit ef44146

File tree

19 files changed

+196
-196
lines changed

19 files changed

+196
-196
lines changed

‎modules/config/README‎

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,13 @@ Config Module
5555

5656
List of Examples
5757

58-
1.1. Set "db_url" parameter
59-
1.2. Set "table_name" parameter
60-
1.3. Set "name_column" parameter
61-
1.4. Set "value_column" parameter
62-
1.5. Set "desctiption_column" parameter
63-
1.6. Set "restart_persistent_memory" parameter
64-
1.7. Set "hash_size" parameter
58+
1.1. Set “db_url” parameter
59+
1.2. Set “table_name” parameter
60+
1.3. Set “name_column” parameter
61+
1.4. Set “value_column” parameter
62+
1.5. Set “desctiption_column” parameter
63+
1.6. Set “restart_persistent_memory” parameter
64+
1.7. Set “hash_size” parameter
6565
1.8. Usage of $config(...)
6666
1.9. Usage of $config.description(name)
6767

@@ -77,13 +77,13 @@ Chapter 1. Admin Guide
7777
All configuration variables are stored in OpenSIPS' internal
7878
cache, allowing fast access during SIP processing to maintain
7979
high performance. The cache can be updated in three ways:
80-
* Script - Assigning a value to the $config(...)
80+
* Script – Assigning a value to the $config(...)
8181
pseudo-variable updates the in-memory cache, but this
8282
change is not persisted to the database.
83-
* MI Commands - Using config_push or config_push_bulk updates
83+
* MI Commands – Using config_push or config_push_bulk updates
8484
one or more variables in the runtime cache. These updates
8585
are also not saved to the database.
86-
* Database - Manually modifying values in the database, then
86+
* Database – Manually modifying values in the database, then
8787
triggering the config_reload command, will refresh the
8888
in-memory cache with updated values from the database.
8989

@@ -125,9 +125,9 @@ Chapter 1. Admin Guide
125125
flush them at runtime using the config_flush MI command.
126126

127127
Default value is
128-
"mysql://opensips:opensipsrw@localhost/opensips".
128+
“mysql://opensips:opensipsrw@localhost/opensips”.
129129

130-
Example 1.1. Set "db_url" parameter
130+
Example 1.1. Set “db_url” parameter
131131
...
132132
modparam("config", "db_url", "dbdriver://username:password@dbhost/dbname
133133
")
@@ -137,9 +137,9 @@ modparam("config", "db_url", "dbdriver://username:password@dbhost/dbname
137137

138138
Name of the table where configuration entries are stored.
139139

140-
Default value is "config".
140+
Default value is “config”.
141141

142-
Example 1.2. Set "table_name" parameter
142+
Example 1.2. Set “table_name” parameter
143143
...
144144
modparam("config", "table_name", "configuration")
145145
...
@@ -148,9 +148,9 @@ modparam("config", "table_name", "configuration")
148148

149149
Name of the column storing configuration variable names.
150150

151-
Default value is "name".
151+
Default value is “name”.
152152

153-
Example 1.3. Set "name_column" parameter
153+
Example 1.3. Set “name_column” parameter
154154
...
155155
modparam("config", "name_column", "key")
156156
...
@@ -159,9 +159,9 @@ modparam("config", "name_column", "key")
159159

160160
Name of the column storing configuration variable values.
161161

162-
Default value is "value".
162+
Default value is “value”.
163163

164-
Example 1.4. Set "value_column" parameter
164+
Example 1.4. Set “value_column” parameter
165165
...
166166
modparam("config", "value_column", "val")
167167
...
@@ -170,9 +170,9 @@ modparam("config", "value_column", "val")
170170

171171
Name of the column storing variable descriptions.
172172

173-
Default value is "description".
173+
Default value is “description”.
174174

175-
Example 1.5. Set "desctiption_column" parameter
175+
Example 1.5. Set “desctiption_column” parameter
176176
...
177177
modparam("config", "description_column", "desc")
178178
...
@@ -182,9 +182,9 @@ modparam("config", "description_column", "desc")
182182
Enables restart persistency. Check the Restart Persistent
183183
Memory for more information.
184184

185-
Default value is "0 / disabled".
185+
Default value is “0 / disabled”.
186186

187-
Example 1.6. Set "restart_persistent_memory" parameter
187+
Example 1.6. Set “restart_persistent_memory” parameter
188188
...
189189
modparam("config", "restart_persistent_memory", yes)
190190
...
@@ -196,9 +196,9 @@ modparam("config", "restart_persistent_memory", yes)
196196
rounded to the closest value of 2 smaller than the provided
197197
value.
198198

199-
Default value is "16".
199+
Default value is “16”.
200200

201-
Example 1.7. Set "hash_size" parameter
201+
Example 1.7. Set “hash_size” parameter
202202
...
203203
modparam("config", "hash_size", 32)
204204
...
@@ -258,9 +258,9 @@ e)\n");
258258
Temporarily pushes a single configuration variable.
259259

260260
Expected parameters are:
261-
* name - (string) the name of the variable
262-
* value - (string) the value of the variable
263-
* description - (string, optional) the description of the
261+
* name – (string) the name of the variable
262+
* value – (string) the value of the variable
263+
* description – (string, optional) the description of the
264264
variable; if missing the description is inheritted, or a
265265
null value is used if the variable is new.
266266

@@ -274,14 +274,14 @@ e)\n");
274274
Pushes multiple temporarily configuration variables in memory.
275275

276276
Expected parameters are:
277-
* configs - (json) a JSON array containing a set of variables
277+
* configs – (json) a JSON array containing a set of variables
278278
to be pushed. Each variable should be described as a JSON
279279
object with the following keys:
280-
+ name - (string) the name of the variable to be
280+
+ name – (string) the name of the variable to be
281281
changed.
282-
+ value - (string or null) the new value of the
282+
+ value – (string or null) the new value of the
283283
variable.
284-
+ description - (string, optional) the description of
284+
+ description – (string, optional) the description of
285285
the variable.
286286

287287
MI FIFO Command Format:
@@ -296,7 +296,7 @@ e)\n");
296296
Flushes the variables from the memory to the database.
297297

298298
Expected parameters are:
299-
* name - (string, optional) if present, flushes only a
299+
* name – (string, optional) if present, flushes only a
300300
specific config variable in database, otherwise the entire
301301
cache.
302302

@@ -314,7 +314,7 @@ Chapter 2. Contributors
314314
Table 2.1. Top contributors by DevScore^(1), authored
315315
commits^(2) and lines added/removed^(3)
316316
Name DevScore Commits Lines ++ Lines --
317-
1. Razvan Crainea (@razvancrainea) 4 1 349 0
317+
1. Razvan Crainea (@razvancrainea) 14 1 1437 0
318318

319319
(1) DevScore = author_commits + author_lines_added /
320320
(project_lines_added / project_commits) + author_lines_deleted
@@ -349,4 +349,4 @@ Chapter 3. Documentation
349349

350350
Documentation Copyrights:
351351

352-
Copyright � 2025 OpenSIPS Solutions;
352+
Copyright © 2025 OpenSIPS Solutions;

‎modules/config/doc/contributors.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
<row>
2222
<entry>1. </entry>
2323
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
24-
<entry align="center">4</entry>
24+
<entry align="center">14</entry>
2525
<entry align="center">1</entry>
26-
<entry align="center">349</entry>
26+
<entry align="center">1437</entry>
2727
<entry align="center">0</entry>
2828
</row>
2929
</tbody>

‎modules/dispatcher/README‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1516,7 +1516,7 @@ Chapter 3. Contributors
15161516
commits^(2) and lines added/removed^(3)
15171517
Name DevScore Commits Lines ++ Lines --
15181518
1. Bogdan-Andrei Iancu (@bogdan-iancu) 169 108 3331 2025
1519-
2. Liviu Chircu (@liviuchircu) 110 71 1679 1440
1519+
2. Liviu Chircu (@liviuchircu) 111 72 1711 1441
15201520
3. Daniel-Constantin Mierla (@miconda) 82 39 3372 844
15211521
4. Andrei Datcu (@andrei-datcu) 48 15 2153 846
15221522
5. Razvan Crainea (@razvancrainea) 46 37 602 175
@@ -1558,8 +1558,8 @@ Chapter 3. Contributors
15581558

15591559
Table 3.2. Most recently active contributors^(1) to this module
15601560
Name Commit Activity
1561-
1. Babak Yakhchali Feb 2025 - Feb 2025
1562-
2. Liviu Chircu (@liviuchircu) Aug 2012 - Jan 2025
1561+
1. Liviu Chircu (@liviuchircu) Aug 2012 - May 2025
1562+
2. Babak Yakhchali Feb 2025 - Feb 2025
15631563
3. Norman Brandinger (@NormB) Nov 2024 - Nov 2024
15641564
4. Alexandra Titoc Sep 2024 - Sep 2024
15651565
5. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2005 - Feb 2024

‎modules/dispatcher/doc/contributors.xml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@
2929
<row>
3030
<entry>2. </entry>
3131
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
32-
<entry align="center">110</entry>
33-
<entry align="center">71</entry>
34-
<entry align="center">1679</entry>
35-
<entry align="center">1440</entry>
32+
<entry align="center">111</entry>
33+
<entry align="center">72</entry>
34+
<entry align="center">1711</entry>
35+
<entry align="center">1441</entry>
3636
</row>
3737
<row>
3838
<entry>3. </entry>
@@ -128,13 +128,13 @@
128128
<tbody>
129129
<row>
130130
<entry>1. </entry>
131-
<entry>Babak Yakhchali</entry>
132-
<entry align="center">Feb 2025 - Feb 2025</entry>
131+
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
132+
<entry align="center">Aug 2012 - May 2025</entry>
133133
</row>
134134
<row>
135135
<entry>2. </entry>
136-
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
137-
<entry align="center">Aug 2012 - Jan 2025</entry>
136+
<entry>Babak Yakhchali</entry>
137+
<entry align="center">Feb 2025 - Feb 2025</entry>
138138
</row>
139139
<row>
140140
<entry>3. </entry>

‎modules/janus/doc/contributors.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
<row>
2222
<entry>1. </entry>
2323
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
24-
<entry align="center">43</entry>
25-
<entry align="center">5</entry>
26-
<entry align="center">4388</entry>
24+
<entry align="center">44</entry>
25+
<entry align="center">6</entry>
26+
<entry align="center">4389</entry>
2727
<entry align="center">5</entry>
2828
</row>
2929
<row>
@@ -73,7 +73,7 @@
7373
<row>
7474
<entry>1. </entry>
7575
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
76-
<entry align="center">Dec 2024 - Mar 2025</entry>
76+
<entry align="center">Dec 2024 - May 2025</entry>
7777
</row>
7878
<row>
7979
<entry>2. </entry>

‎modules/proto_hep/README‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ Chapter 3. Contributors
352352
commits^(2) and lines added/removed^(3)
353353
Name DevScore Commits Lines ++ Lines --
354354
1. Ionut Ionita (@ionutrazvanionita) 151 66 8047 998
355-
2. Razvan Crainea (@razvancrainea) 38 29 85 488
355+
2. Razvan Crainea (@razvancrainea) 39 30 92 488
356356
3. Bogdan-Andrei Iancu (@bogdan-iancu) 27 20 391 175
357357
4. Liviu Chircu (@liviuchircu) 18 15 81 92
358358
5. Bence Szigeti 9 2 405 180
@@ -384,8 +384,8 @@ Chapter 3. Contributors
384384

385385
Table 3.2. Most recently active contributors^(1) to this module
386386
Name Commit Activity
387-
1. Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2017 - May 2024
388-
2. Razvan Crainea (@razvancrainea) Nov 2015 - Feb 2024
387+
1. Razvan Crainea (@razvancrainea) Nov 2015 - Apr 2025
388+
2. Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2017 - May 2024
389389
3. Maksym Sobolyev (@sobomax) Feb 2023 - Nov 2023
390390
4. Bence Szigeti Jul 2023 - Aug 2023
391391
5. Liviu Chircu (@liviuchircu) Mar 2016 - Oct 2022

‎modules/proto_hep/doc/contributors.xml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@
2929
<row>
3030
<entry>2. </entry>
3131
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
32-
<entry align="center">38</entry>
33-
<entry align="center">29</entry>
34-
<entry align="center">85</entry>
32+
<entry align="center">39</entry>
33+
<entry align="center">30</entry>
34+
<entry align="center">92</entry>
3535
<entry align="center">488</entry>
3636
</row>
3737
<row>
@@ -128,13 +128,13 @@
128128
<tbody>
129129
<row>
130130
<entry>1. </entry>
131-
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
132-
<entry align="center">Jan 2017 - May 2024</entry>
131+
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
132+
<entry align="center">Nov 2015 - Apr 2025</entry>
133133
</row>
134134
<row>
135135
<entry>2. </entry>
136-
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
137-
<entry align="center">Nov 2015 - Feb 2024</entry>
136+
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
137+
<entry align="center">Jan 2017 - May 2024</entry>
138138
</row>
139139
<row>
140140
<entry>3. </entry>

‎modules/proto_ipsec/README‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ Chapter 2. Contributors
383383
Table 2.1. Top contributors by DevScore^(1), authored
384384
commits^(2) and lines added/removed^(3)
385385
Name DevScore Commits Lines ++ Lines --
386-
1. Razvan Crainea (@razvancrainea) 61 16 4483 373
386+
1. Razvan Crainea (@razvancrainea) 62 17 4491 373
387387
2. Liviu Chircu (@liviuchircu) 4 2 23 15
388388
3. Alexandra Titoc 3 1 1 1
389389

@@ -407,7 +407,7 @@ Chapter 2. Contributors
407407

408408
Table 2.2. Most recently active contributors^(1) to this module
409409
Name Commit Activity
410-
1. Razvan Crainea (@razvancrainea) Apr 2024 - Sep 2024
410+
1. Razvan Crainea (@razvancrainea) Apr 2024 - Apr 2025
411411
2. Alexandra Titoc Sep 2024 - Sep 2024
412412
3. Liviu Chircu (@liviuchircu) May 2024 - May 2024
413413

‎modules/proto_ipsec/doc/contributors.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
<row>
2222
<entry>1. </entry>
2323
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
24-
<entry align="center">61</entry>
25-
<entry align="center">16</entry>
26-
<entry align="center">4483</entry>
24+
<entry align="center">62</entry>
25+
<entry align="center">17</entry>
26+
<entry align="center">4491</entry>
2727
<entry align="center">373</entry>
2828
</row>
2929
<row>
@@ -73,7 +73,7 @@
7373
<row>
7474
<entry>1. </entry>
7575
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
76-
<entry align="center">Apr 2024 - Sep 2024</entry>
76+
<entry align="center">Apr 2024 - Apr 2025</entry>
7777
</row>
7878
<row>
7979
<entry>2. </entry>

‎modules/rtpproxy/README‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -978,7 +978,7 @@ Chapter 3. Contributors
978978
Name DevScore Commits Lines ++ Lines --
979979
1. Razvan Crainea (@razvancrainea) 266 167 6172 2881
980980
2. Maksym Sobolyev (@sobomax) 63 13 5132 308
981-
3. Liviu Chircu (@liviuchircu) 28 22 228 243
981+
3. Liviu Chircu (@liviuchircu) 29 23 229 244
982982
4. Bogdan-Andrei Iancu (@bogdan-iancu) 27 23 123 116
983983
5. Vlad Patrascu (@rvlad-patrascu) 25 9 409 725
984984
6. Peter Lemenkov (@lemenkov) 7 5 60 59
@@ -1013,9 +1013,9 @@ Chapter 3. Contributors
10131013

10141014
Table 3.2. Most recently active contributors^(1) to this module
10151015
Name Commit Activity
1016-
1. Razvan Crainea (@razvancrainea) Mar 2011 - Jan 2025
1017-
2. Norman Brandinger (@NormB) Jun 2024 - Jun 2024
1018-
3. Liviu Chircu (@liviuchircu) Jul 2012 - May 2023
1016+
1. Liviu Chircu (@liviuchircu) Jul 2012 - Apr 2025
1017+
2. Razvan Crainea (@razvancrainea) Mar 2011 - Jan 2025
1018+
3. Norman Brandinger (@NormB) Jun 2024 - Jun 2024
10191019
4. Maksym Sobolyev (@sobomax) Mar 2011 - May 2023
10201020
5. Vlad Patrascu (@rvlad-patrascu) May 2017 - Mar 2023
10211021
6. Peter Lemenkov (@lemenkov) Dec 2011 - Apr 2022

0 commit comments

Comments
 (0)