Module: kamailio Branch: 5.6 Commit: 1107423f6af0df4d788216324d6547247fa22224 URL: https://github.com/kamailio/kamailio/commit/1107423f6af0df4d788216324d654724...

Author: Daniel-Constantin Mierla miconda@gmail.com Committer: Daniel-Constantin Mierla miconda@gmail.com Date: 2023-02-24T13:52:57+01:00

rr: doc - fixed typos and use the proper param name add_username instead of enable_username

(cherry picked from commit 022fa0cfc75d150fde219b8ae4f9a99b3fa2f132)

---

Modified: src/modules/rr/doc/rr_admin.xml Modified: src/modules/rr/doc/rr_devel.xml

---

Diff: https://github.com/kamailio/kamailio/commit/1107423f6af0df4d788216324d654724... Patch: https://github.com/kamailio/kamailio/commit/1107423f6af0df4d788216324d654724...

---

diff --git a/src/modules/rr/doc/rr_admin.xml b/src/modules/rr/doc/rr_admin.xml index 98bad1239f2..c1ad84277ed 100644 --- a/src/modules/rr/doc/rr_admin.xml +++ b/src/modules/rr/doc/rr_admin.xml @@ -12,7 +12,7 @@ <section> <title>Overview</title>

- <para>The module contains record routing logic</para> + <para>The module contains record routing logic.</para> </section>

<section id="RR-dialog-id"> @@ -20,7 +20,7 @@

<para>&kamailio; is basically <emphasis>only</emphasis> a transaction stateful proxy, without any dialog support build in. There are many - features/services which actually requires a dialog awareness, like storing + features/services which actually require a dialog awareness, like storing the information in the dialog creation stage, information which will be used during the whole dialog existence.</para>

@@ -246,7 +246,7 @@ modparam("rr", "enable_socket_mismatch_warning", 0) <section id="rr.p.custom_user_avp"> <title><varname>custom_user_avp</varname> (avp string)</title>

- <para>When enable_username is enabled, a call to record_route will add + <para>When add_username is enabled, a call to record_route will add the username of the RequestURI to the Record-Route URI. This parameter allows you to setup an AVP with which you can customise the username to be added in the Record-Route URI.</para> @@ -664,7 +664,7 @@ add_rr_param(";nat=yes");

<para>The function checks if the URI parameters of the local Route header (corresponding to the local server) matches the given regular - expression. It must be call after loose_route() (see <xref + expression. It must be called after loose_route() (see <xref linkend="rr.f.loose_route"/>).</para>

<para>Meaning of the parameters is as follows:</para> diff --git a/src/modules/rr/doc/rr_devel.xml b/src/modules/rr/doc/rr_devel.xml index 9d16ea0791f..a451c4fb4dd 100644 --- a/src/modules/rr/doc/rr_devel.xml +++ b/src/modules/rr/doc/rr_devel.xml @@ -128,7 +128,7 @@ record_route_advertised_address("1.2.3.4:5090"); The function checks for the request <quote>msg</quote> if the URI parameters of the local Route header (corresponding to the local server) matches the given regular expression <quote>re</quote>. - It must be call after the loose_route was done. + It must be called after the loose_route was done. </para> <para> The function returns 0 on success. Otherwise, -1 is returned. @@ -157,7 +157,7 @@ record_route_advertised_address("1.2.3.4:5090"); <quote>msg</quote>. As for checking it's used the <quote>ftag</quote> Route header parameter, the append_fromtag (see <xref linkend="append-fromtag-id"/> module parameter - must be enables. Also this must be call only after the loose_route is + must be enables. Also this must be called only after the loose_route is done. </para> <para> @@ -185,9 +185,9 @@ record_route_advertised_address("1.2.3.4:5090"); <function moreinfo="none">get_route_param( msg, name, val)</function> </title> <para> - The function search in to the <quote>msg</quote>'s Route header + The function searches in the <quote>msg</quote>'s Route header parameters the parameter called <quote>name</quote> and returns its - value into <quote>val</quote>. It must be call only after the + value into <quote>val</quote>. It must be called only after the loose_route is done. </para> <para> @@ -220,7 +220,7 @@ record_route_advertised_address("1.2.3.4:5090"); <function moreinfo="none">register_rrcb( callback, param)</function> </title> <para> - The function register a new callback (along with its parameter). The + The function registers a new callback (along with its parameter). The callback will be called when a loose route will be performed for the local address. </para>