git:master: pv: doc updated - sr-dev

3 May 2009

Module: sip-router
Branch: master
Commit: 941c2ca3e031a1ad100ed92ce4e7447c0dfe3ea1
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=941c2ca3...
Author: Daniel-Constantin Mierla miconda@gmail.com
Committer: Daniel-Constantin Mierla miconda@gmail.com
Date:   Sun May  3 14:47:21 2009 +0200
pv: doc updated
---
modules_k/pv/README           |   31 +++++++++++++++++++++++--------
 modules_k/pv/doc/pv_admin.xml |   19 +++++++++++++++++++
 2 files changed, 42 insertions(+), 8 deletions(-)

diff --git a/modules_k/pv/README b/modules_k/pv/README
index 9c6ef99..6b9b892 100644
--- a/modules_k/pv/README
+++ b/modules_k/pv/README
@@ -28,6 +28,7 @@ Daniel-Constantin Mierla
3.1. shvset (string)
               3.2. varset (string)
+              3.3. avp_aliases (string)
4. Exported Functions
@@ -43,10 +44,11 @@ Daniel-Constantin Mierla
1.1. shvset parameter usage
    1.2. varset parameter usage
-   1.3. pv_isset usage
-   1.4. pv_unset usage
-   1.5. shv_set usage
-   1.6. shv_get usage
+   1.3. avp_aliases parameter usage
+   1.4. pv_isset usage
+   1.5. pv_unset usage
+   1.6. shv_set usage
+   1.7. shv_get usage
Chapter 1. Admin Guide
@@ -62,6 +64,7 @@ Chapter 1. Admin Guide
3.1. shvset (string)
         3.2. varset (string)
+        3.3. avp_aliases (string)
4. Exported Functions
@@ -99,6 +102,7 @@ Chapter 1. Admin Guide
3.1. shvset (string)
    3.2. varset (string)
+   3.3. avp_aliases (string)
3.1. shvset (string)
@@ -142,6 +146,17 @@ modparam("pv", "varset", "init=i:1")
 modparam("pv", "varset", "gw=s:sip:11.11.11.11;transport=tcp")
 ...
+3.3. avp_aliases (string)
+
+   Define aliases for PV AVP names.
+
+   Default value is NULL.
+
+   Example 1.3. avp_aliases parameter usage
+...
+modparam("pv","avp_aliases","email=s:email_addr;tmp=i:100")
+...
+
 4. Exported Functions
4.1. pv_isset(pvar)
@@ -156,7 +171,7 @@ modparam("pv", "varset", "gw=s:sip:11.11.11.11;transport=tcp")
This function can be used from ANY_ROUTE.
-   Example 1.3. pv_isset usage
+   Example 1.4. pv_isset usage
 ...
 if(pv_isset("$avp("s:x")"))
 {
@@ -173,7 +188,7 @@ if(pv_isset("$avp("s:x")"))
This function can be used from ANY_ROUTE.
-   Example 1.4. pv_unset usage
+   Example 1.5. pv_unset usage
 ...
 pv_unset("$avp("s:x")");
 ...
@@ -201,7 +216,7 @@ pv_unset("$avp("s:x")");
                 _value_
                 _empty_line_
-   Example 1.5. shv_set usage
+   Example 1.6. shv_set usage
 ...
 $ kamctl fifo shv_set debug int 0
 ...
@@ -219,7 +234,7 @@ $ kamctl fifo shv_set debug int 0
                 _name_
                 _empty_line_
-   Example 1.6. shv_get usage
+   Example 1.7. shv_get usage
 ...
 $ kamctl fifo shv_get debug
 $ kamctl fifo shv_get
diff --git a/modules_k/pv/doc/pv_admin.xml b/modules_k/pv/doc/pv_admin.xml
index f8b50ad..f6d42cf 100644
--- a/modules_k/pv/doc/pv_admin.xml
+++ b/modules_k/pv/doc/pv_admin.xml
@@ -124,6 +124,25 @@ modparam("pv", "varset", "gw=s:sip:11.11.11.11;transport=tcp")
 </programlisting>
        </example>
    </section>
+		<section>
+			<title><varname>avp_aliases</varname> (string)</title>
+			<para>
+			Define aliases for PV AVP names.
+			</para>
+			<para>
+				<emphasis>
+					Default value is NULL.
+				</emphasis>
+			</para>
+			<example>
+				<title><varname>avp_aliases</varname> parameter usage</title>
+				<programlisting format="linespecific">
+...
+modparam("pv","avp_aliases","email=s:email_addr;tmp=i:100")
+...
+				</programlisting>
+			</example>
+		</section>
    </section>
    <section>
    <title>Exported Functions</title>

    