Merge pull request #881 from mslehto/doctypo
authorOlle E. Johansson <oej@edvina.net>
Sun, 4 Dec 2016 16:43:08 +0000 (17:43 +0100)
committerGitHub <noreply@github.com>
Sun, 4 Dec 2016 16:43:08 +0000 (17:43 +0100)
documentation fixes for various modules

1  2 
modules/dispatcher/doc/dispatcher_admin.xml
modules/rtpproxy/doc/rtpproxy_admin.xml

@@@ -10,7 -10,7 +10,7 @@@
  <!-- Module User's Guide -->
  
  <chapter xmlns:xi="http://www.w3.org/2001/XInclude">
 -      
 +
        <title>&adminguide;</title>
  
        <section>
@@@ -29,7 -29,7 +29,7 @@@
        </para>
        <para>
                It is very lightweight, therefore suitable for handling heavy SIP
 -              traffic. As the module has a small footprint and the ability to load 
 +              traffic. As the module has a small footprint and the ability to load
                balancing rules from a plain text file, it is suitable for embedded systems.
        </para>
        </section>
@@@ -537,11 -537,11 +537,11 @@@ modparam("dispatcher", "force_dst", 1
   ...
   </programlisting>
                </example>
 -      </section>      
 +      </section>
        <section id="dispatcher.p.ds_ping_from">
                <title><varname>ds_ping_from</varname> (string)</title>
                <para>
 -              With this Method you can define the "From:"-Line for the request, sent to the failed gateways.          
 +              With this Method you can define the "From:"-Line for the request, sent to the failed gateways.
                This method is only available, if compiled with the probing of failed gateways enabled.
                </para>
                <para>
   ...
   </programlisting>
                </example>
 -      </section>      
 +      </section>
  
        <section id="dispatcher.p.ds_ping_interval">
                <title><varname>ds_ping_interval</varname> (int)</title>
   ...
   </programlisting>
                </example>
 -      </section>      
 -      
 +      </section>
 +
        <section id="dispatcher.p.ds_probing_threshold">
                <title><varname>ds_probing_threshold</varname> (int)</title>
                <para>
                        PING-Method are not only the ones generated from the remote servers, but also those
                        that are generated locally. E.g.: setting code=408 or class=400 will never set
                        a backend down even if it is, because internally the Kamailio transaction layer
 -                      generates a 408 in the case of no response from the remote server, and this 
 +                      generates a 408 in the case of no response from the remote server, and this
                        internal code 408 is accepted as valid value.
                </para>
                <para>
   ...
   </programlisting>
                </example>
 -      </section>      
 +      </section>
        <section id="dispatcher.p.ds_probing_mode">
                <title><varname>ds_probing_mode</varname> (int)</title>
                <para>
 -              Controls what gateways are tested to see if they are reachable. 
 +              Controls what gateways are tested to see if they are reachable.
                </para>
  
                <itemizedlist>
                <title><varname>ds_timer_mode</varname> (int)</title>
                <para>
                        Specify the timer process to be used by the module for
 -                      keepalives and active dialogs tracking. 
 +                      keepalives and active dialogs tracking.
                </para>
                <para>
                        It can be set to:
                                <para>
                                <quote>11</quote> - use relative weight based load distribution.
                                You have to set the attribute 'rweight' per each address in
 -                              destination set. Active host usage probability is 
 -                              rweight/(SUM of all active host rweights in destination group). 
 +                              destination set. Active host usage probability is
 +                              rweight/(SUM of all active host rweights in destination group).
                                </para>
                                <para>
                                The major difference from the weight distribution is the
 -                              probability recalculation according to rweight value in case of 
 +                              probability recalculation according to rweight value in case of
                                host enabling/disabling
                                </para>
                                <para>
 -                              For example, 100 calls in 3-hosts group with rweight params 1/2/1  
 -                              will be distributed as 25/50/25. After third host failing 
 +                              For example, 100 calls in 3-hosts group with rweight params 1/2/1
 +                              will be distributed as 25/50/25. After third host failing
                                distribution will be changed to 33/67/0.
                                </para>
                        </listitem>
@@@ -1167,7 -1167,7 +1167,7 @@@ if(ds_select("1", "$var(a)")) 
                                addition to one of the previous flags - the last destination
                                will be set to probing. This mean the destination will be pinged
                                with SIP OPTIONS requests from time to time to detect if it is
-                               up running or down.</para>
+                               up or down.</para>
                </listitem>
                </itemizedlist>
                <para>
@@@ -1374,7 -1374,7 +1374,7 @@@ onreply_route 
                <function moreinfo="none">ds_set_state</function>
                </title>
                <para>
 -        Sets the status for a destination address (can be use to mark the destination 
 +        Sets the status for a destination address (can be use to mark the destination
                as active or inactive).
                </para>
                <para>
                        <listitem><para>_state_ : state of the destination address</para>
                              <itemizedlist>
                         <listitem><para> <quote>a</quote>: active</para></listitem> 
 -                               <listitem><para> <quote>i</quote>: inactive</para></listitem>  
 -                               <listitem><para> <quote>t</quote>: trying</para></listitem>    
 -                               <listitem><para> <quote>d</quote>: disabled</para></listitem>  
 +                               <listitem><para> <quote>i</quote>: inactive</para></listitem>
 +                               <listitem><para> <quote>t</quote>: trying</para></listitem>
 +                               <listitem><para> <quote>d</quote>: disabled</para></listitem>
                                  </itemizedlist>
                                  <para>The states <quote>a</quote>, <quote>i</quote> or
                                          <quote>t</quote> can be followed by <quote>p</quote>
                                          to set probing mode (e.g. 'ap', 'ip' or 'tp').</para>
 -                      </listitem>       
 +                      </listitem>
  
                        <listitem><para>_group_: destination group id</para></listitem>
 -                      
 +
                        <listitem><para>_address_: address of the destination in the _group_</para></listitem>
                </itemizedlist>
                <para>
                                        sent to that gateways.
                                </listitem>
                                <listitem>
 -                                      'rweight' - used for relative weight based load 
 -                                      distribution. It must be set to a positive integer value 
 -                                      between 1 and 100 (otherwise host will be excluded from 
 -                                      relative weight distribution type). 
 +                                      'rweight' - used for relative weight based load
 +                                      distribution. It must be set to a positive integer value
 +                                      between 1 and 100 (otherwise host will be excluded from
 +                                      relative weight distribution type).
                                </listitem>
                                <listitem>
                                        'socket' - used to set the sending socket for the gateway.
@@@ -1675,11 -1675,11 +1675,11 @@@ setid(int) destination(sip uri) flags(i
                </example>
                </section>
                </section>
 -      
 +
                <section id="dispatcher.ex.config">
                <title>&kamailio; config file</title>
                <para>
 -              Next picture shows a sample usage of the dispatcher module.
 +              Next listing shows a sample config for using the dispatcher module.
                </para>
                <example>
                <title>&kamailio; config script - sample dispatcher usage</title>
@@@ -456,7 -456,7 +456,7 @@@ rtpproxy_offer()
                                So, for example if a SIP requests is processed with 'ie' flags, the corresponding
                                response must be processed with 'ie' flags.
                                </para><para>
-                               Note: As rtpproxy in bridge mode s per default asymmetric, you have to specify
+                               Note: As rtpproxy in bridge mode is asymmetric per default, you have to specify
                                the 'w' flag for clients behind NAT! See also above notes!
                                </para></listitem>
                                <listitem><para>
@@@ -680,12 -680,7 +680,12 @@@ rtpproxy_destroy()
                </listitem>
                <listitem>
                        <para>
 -                      If BYE or CANCEL, or called within a FAILURE_ROUTE[], then do <function>unforce_rtpproxy()</function>
 +                      If BYE or CANCEL, or called within a FAILURE_ROUTE[], then call
 +                      <function>unforce_rtpproxy()</function>. Be careful with calling
 +                      this function after resuming a suspended transaction (e.g., after
 +                      t_continue()), because the context of executed route is FAILURE
 +                      ROUTE (in other words, rtpproxy_manage() in the route block of
 +                      t_continue() does the same as in failure_route).
                        </para>
                </listitem>
                <listitem>
@@@ -769,7 -764,7 +769,7 @@@ rtpproxy_manage()
  ...
      if (is_method("INVITE")) {
          rtpproxy_offer();
-         if (detect_hold()) {
+         if (is_audio_on_hold()) {
              rtpproxy_stream2uas("/var/rtpproxy/prompts/music_on_hold", "-1");
          } else {
              rtpproxy_stop_stream2uas();