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 Aug 5, 2018
1 parent bb811b3 commit e881143
Show file tree
Hide file tree
Showing 66 changed files with 1,001 additions and 945 deletions.
128 changes: 64 additions & 64 deletions modules/acc/README
View file
Expand Up @@ -70,13 +70,13 @@ Acc Module
1.8.4. acc_db_request(comment, table)
1.8.5. acc_aaa_request(comment)
1.8.6. acc_evi_request(comment)
1.8.7. acc_new_leg()

1.9. acc_new_leg()
1.10. Exported Events
1.9. Exported Events

1.10.1. E_ACC_CDR
1.10.2. E_ACC_EVENT
1.10.3. E_ACC_MISSED_EVENT
1.9.1. E_ACC_CDR
1.9.2. E_ACC_EVENT
1.9.3. E_ACC_MISSED_EVENT

2. Frequently Asked Questions
3. Contributors
Expand Down Expand Up @@ -229,7 +229,7 @@ if ($ru=~"sip:+40") /* calls to Romania */ {
Extra values are consistent during the whole call. Setting a
value during a request, will cause it to remain visible during
all replies. Also, concerning CDR logging, setting a value on
the initial INVITIE will result in having that value throughout
the initial INVITE will result in having that value throughout
the dialog.

Via log_name you define how/where the data will be logged. Its
Expand All @@ -252,7 +252,7 @@ if ($ru=~"sip:+40") /* calls to Romania */ {
modparam("acc", "extra_fields", "log: a -> test_a")

will enable you to set the value for test_a field of the log
only by setting $acc_etra(a) variable. Otherwise, the field
only by setting $acc_extra(a) variable. Otherwise, the field
shall be logged with no value(null).

1.2.4. Radius accounting dependencies
Expand Down Expand Up @@ -280,7 +280,7 @@ modparam("acc", "extra_fields", "log: a -> test_a")

First how it works: The idea is to have a variable to store a
set of values for each leg. The meaning of the variable content
is stricly decided by the script writer - it can be the origin
is strictly decided by the script writer - it can be the origin
and source of the leg, its status or any other related
information. By default there is defined only one leg. Script
writer has to decide when is the time to create a new leg, by
Expand Down Expand Up @@ -449,10 +449,10 @@ modparam("acc", "extra_fields","a->2345;b->2346")
Example 1.5. Setting leg_fields example:
# for syslog-based accounting, use any text you want to be printed
# if setting $(acc_leg(a)[0]) you will see "My_a_Field=<value> in logs
# if setting $(acc_extra(b)[0]) you will see "b=<value> in logs
# if setting $(acc_leg(b)[0]) you will see "b=<value> in logs
modparam("acc", "leg_fields", "log: a->My_a_Field; b")
# for mysql-based accounting, use the names of the columns
# $acc_extra(a) = <value> results in setting col_a with <value> in db
# $acc_leg(a) = <value> results in setting col_a with <value> in db
modparam("acc", "leg_fields", "db: a->col_a; col_b")
# for AAA-based accounting, use the names of the AAA AVPs
modparam("acc", "leg_fields","aaa:a->AAA_LEG_SRC;b->AAA_LEG_DST")
Expand Down Expand Up @@ -636,8 +636,8 @@ modparam("acc", "acc_created_avp_name", "call_created_avp")

1.7.3. $acc_current_leg (read-only)

Variable holding the value for the current leg. Calling
acc_new_leg() will increase the value of this variable.
Holds the index of the current leg, starting from 0. Calling
acc_new_leg() will increment this index.

1.8. Exported Functions

Expand Down Expand Up @@ -838,11 +838,11 @@ acc_aaa_request("403 Destination not allowed");
acc_evi_request("403 Destination not allowed");
...

1.9. acc_new_leg()
1.8.7. acc_new_leg()

Creates a new leg only if multi-leg accounting is used. The
value of acc_current_leg variable is incremented. All the
values of the new leg will be initialised with null.
Creates a new leg and increments $acc_current_leg only if
multi-leg accounting is used. All values of the new leg will be
initialized to null.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
BRANCH_ROUTE and LOCAL_ROUTE.
Expand All @@ -852,9 +852,9 @@ acc_evi_request("403 Destination not allowed");
acc_new_leg();
...

1.10. Exported Events
1.9. Exported Events

1.10.1. E_ACC_CDR
1.9.1. E_ACC_CDR

The event raised when a CDR is generated. Note that this event
will only be triggered if the auto CDR accounting is used.
Expand All @@ -880,7 +880,7 @@ acc_evi_request("403 Destination not allowed");
* created - The timestamp when the call was created (the
initial Invite was received)

1.10.2. E_ACC_EVENT
1.9.2. E_ACC_EVENT

This event is triggered when old-style accounting is used. It
is generated when the requests (INVITE and BYE) transaction
Expand All @@ -900,7 +900,7 @@ acc_evi_request("403 Destination not allowed");
* multi_leg_info* - Extra parameters added by the
multi_leg_info parameter

1.10.3. E_ACC_MISSED_EVENT
1.9.3. E_ACC_MISSED_EVENT

This event is triggered when old-style accounting is used. It
is generated when the requests (INVITE and BYE) transaction
Expand All @@ -926,71 +926,71 @@ Chapter 2. Frequently Asked Questions

2.1.

What happened with old report_ack parameter
What happened with old report_ack parameter

The parameter is considered obsolete. It was removed as acc
module is doing SIP transaction based accouting and according
to SIP RFC, end2end ACKs are a different transaction (still
part of the same dialog). ACKs can be individually accouted as
any other sequential (in-dialog) request.
$
The parameter is considered obsolete. It was removed as acc
module is doing SIP transaction based accouting and according
to SIP RFC, end2end ACKs are a different transaction (still
part of the same dialog). ACKs can be individually accouted as
any other sequential (in-dialog) request.
$

2.2.

What happened with old log_fmt parameter
What happened with old log_fmt parameter

The parameter became obsolete with the restructure of the data
logged by ACC module (refer to the Overview chapter). For
similar behaviour you can use the extra accouting (see the
corresponding chapter).
The parameter became obsolete with the restructure of the data
logged by ACC module (refer to the Overview chapter). For
similar behaviour you can use the extra accouting (see the
corresponding chapter).

2.3.

What happened with old multi_leg_enabled parameter
What happened with old multi_leg_enabled parameter

The parameter became obsolete by the addition of the new
multi_leg_info parameter. The multi-leg accouting is
automatically enabled when multi_leg_info is defined.
The parameter became obsolete by the addition of the new
multi_leg_info parameter. The multi-leg accouting is
automatically enabled when multi_leg_info is defined.

2.4.

What happened with old src_leg_avp_id and dst_leg_avp_id
parameters
What happened with old src_leg_avp_id and dst_leg_avp_id
parameters

The parameter was replaced by the more generic new parameter
multi_leg_info. This allows logging (per-leg) of more
information than just dst and src.
The parameter was replaced by the more generic new parameter
multi_leg_info. This allows logging (per-leg) of more
information than just dst and src.

2.5.

Where can I find more about OpenSIPS?
Where can I find more about OpenSIPS?

Take a look at http://www.opensips.org/.
Take a look at http://www.opensips.org/.

2.6.

Where can I post a question about this module?
Where can I post a question about this module?

First at all check if your question was already answered on one
of our mailing lists:
* User Mailing List -
http://lists.opensips.org/cgi-bin/mailman/listinfo/users
* Developer Mailing List -
http://lists.opensips.org/cgi-bin/mailman/listinfo/devel
First at all check if your question was already answered on one
of our mailing lists:
* User Mailing List -
http://lists.opensips.org/cgi-bin/mailman/listinfo/users
* Developer Mailing List -
http://lists.opensips.org/cgi-bin/mailman/listinfo/devel

E-mails regarding any stable OpenSIPS release should be sent to
<users@lists.opensips.org> and e-mails regarding development
versions should be sent to <devel@lists.opensips.org>.
E-mails regarding any stable OpenSIPS release should be sent to
<users@lists.opensips.org> and e-mails regarding development
versions should be sent to <devel@lists.opensips.org>.

If you want to keep the mail private, send it to
<users@lists.opensips.org>.
If you want to keep the mail private, send it to
<users@lists.opensips.org>.

2.7.

How can I report a bug?
How can I report a bug?

Please follow the guidelines provided at:
https://github.com/OpenSIPS/opensips/issues.
Please follow the guidelines provided at:
https://github.com/OpenSIPS/opensips/issues.

Chapter 3. Contributors

Expand All @@ -999,12 +999,12 @@ 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) 218 103 4144 4534
1. Bogdan-Andrei Iancu (@bogdan-iancu) 219 104 4145 4535
2. Jan Janak (@janakj) 151 16 5587 5074
3. Ionut Ionita (@ionutrazvanionita) 144 39 3730 4180
4. Razvan Crainea (@razvancrainea) 73 48 2390 300
5. Jiri Kuthan (@jiriatipteldotorg) 56 26 2272 660
6. Liviu Chircu (@liviuchircu) 33 24 347 301
6. Liviu Chircu (@liviuchircu) 35 26 357 312
7. Daniel-Constantin Mierla (@miconda) 26 23 115 88
8. Elena-Ramona Modroiu 23 4 2267 5
9. Henning Westerholt (@henningw) 20 15 184 131
Expand Down Expand Up @@ -1039,8 +1039,8 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2003 - Jun 2018
2. Liviu Chircu (@liviuchircu) Jan 2013 - Jun 2018
1. Liviu Chircu (@liviuchircu) Jan 2013 - Aug 2018
2. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2003 - Jul 2018
3. Razvan Crainea (@razvancrainea) Aug 2010 - May 2018
4. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2018
5. Ionut Ionita (@ionutrazvanionita) Feb 2015 - May 2017
Expand All @@ -1067,8 +1067,8 @@ Chapter 4. Documentation

4.1. Contributors

Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Liviu
Chircu (@liviuchircu), Vlad Patrascu (@rvlad-patrascu), Ionut
Last edited by: Liviu Chircu (@liviuchircu), Bogdan-Andrei
Iancu (@bogdan-iancu), Vlad Patrascu (@rvlad-patrascu), Ionut
Ionita (@ionutrazvanionita), Razvan Crainea (@razvancrainea),
Ryan Bullock (@rrb3942), Irina-Maria Stanescu, Sergio
Gutierrez, Henning Westerholt (@henningw), Daniel-Constantin
Expand Down
26 changes: 13 additions & 13 deletions modules/acc/doc/contributors.xml
View file
Expand Up @@ -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">218</entry>
<entry align="center">103</entry>
<entry align="center">4144</entry>
<entry align="center">4534</entry>
<entry align="center">219</entry>
<entry align="center">104</entry>
<entry align="center">4145</entry>
<entry align="center">4535</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -61,10 +61,10 @@
<row>
<entry>6. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">33</entry>
<entry align="center">24</entry>
<entry align="center">347</entry>
<entry align="center">301</entry>
<entry align="center">35</entry>
<entry align="center">26</entry>
<entry align="center">357</entry>
<entry align="center">312</entry>
</row>
<row>
<entry>7. </entry>
Expand Down Expand Up @@ -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">Dec 2003 - Jun 2018</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jan 2013 - Aug 2018</entry>
</row>
<row>
<entry>2. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jan 2013 - Jun 2018</entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Dec 2003 - Jul 2018</entry>
</row>
<row>
<entry>3. </entry>
Expand Down Expand Up @@ -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>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Ryan Bullock (<ulink url="https://github.com/rrb3942">@rrb3942</ulink>), Irina-Maria Stanescu, Sergio Gutierrez, Henning Westerholt (<ulink url="https://github.com/henningw">@henningw</ulink>), Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Konstantin Bokarius, Edson Gellert Schubert, Elena-Ramona Modroiu, Jan Janak (<ulink url="https://github.com/janakj">@janakj</ulink>), Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>), Elena-Ramona Modroiu.</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>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Ryan Bullock (<ulink url="https://github.com/rrb3942">@rrb3942</ulink>), Irina-Maria Stanescu, Sergio Gutierrez, Henning Westerholt (<ulink url="https://github.com/henningw">@henningw</ulink>), Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Konstantin Bokarius, Edson Gellert Schubert, Elena-Ramona Modroiu, Jan Janak (<ulink url="https://github.com/janakj">@janakj</ulink>), Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>), Elena-Ramona Modroiu.</para>
</section>

</chapter>
16 changes: 8 additions & 8 deletions modules/alias_db/README
View file
Expand Up @@ -244,19 +244,19 @@ Chapter 2. Frequently Asked Questions

2.1.

What happened with old use_domain parameter
What happened with old use_domain parameter

The global parameter (affecting the entire module) was replaced
with a per lookup parameter (affecting only current lookup).
See the "d" (do not used domain part) flag in the
db_alias_lookup() and db_alias_find() functions.
The global parameter (affecting the entire module) was replaced
with a per lookup parameter (affecting only current lookup).
See the "d" (do not used domain part) flag in the
db_alias_lookup() and db_alias_find() functions.

2.2.

How can I report a bug?
How can I report a bug?

Please follow the guidelines provided at:
https://github.com/OpenSIPS/opensips/issues.
Please follow the guidelines provided at:
https://github.com/OpenSIPS/opensips/issues.

Chapter 3. Contributors

Expand Down
8 changes: 4 additions & 4 deletions modules/auth_db/README
View file
Expand Up @@ -333,8 +333,8 @@ Chapter 2. Contributors
1. Jan Janak (@janakj) 50 29 1610 424
2. Bogdan-Andrei Iancu (@bogdan-iancu) 39 31 332 232
3. Daniel-Constantin Mierla (@miconda) 29 20 130 382
4. Henning Westerholt (@henningw) 11 9 83 49
5. Liviu Chircu (@liviuchircu) 11 8 36 67
4. Liviu Chircu (@liviuchircu) 12 9 37 68
5. Henning Westerholt (@henningw) 11 9 83 49
6. Sergio Gutierrez 7 5 13 13
7. Andrei Pelinescu-Onciul 6 4 81 33
8. Razvan Crainea (@razvancrainea) 6 4 26 46
Expand Down Expand Up @@ -367,8 +367,8 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Bogdan-Andrei Iancu (@bogdan-iancu) Jun 2005 - Jun 2018
2. Liviu Chircu (@liviuchircu) Mar 2014 - Jun 2018
1. Liviu Chircu (@liviuchircu) Mar 2014 - Jul 2018
2. Bogdan-Andrei Iancu (@bogdan-iancu) Jun 2005 - Jun 2018
3. Vlad Patrascu (@rvlad-patrascu) May 2017 - May 2017
4. Julián Moreno Patiño Feb 2016 - Feb 2016
5. Razvan Crainea (@razvancrainea) Jun 2011 - Aug 2015
Expand Down

0 comments on commit e881143

Please sign in to comment.