[sr-dev] git:master: ipops Minor updates to README

Module: sip-router Branch: master Commit: a9ca3f4a05d0655b11ba90bc64d68b53c4ba039c URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=a9ca3f4… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Fri Feb 8 21:03:07 2013 +0100 ipops Minor updates to README --- modules/ipops/README | 15 +++++++++------ modules/ipops/doc/ipops_admin.xml | 11 +++++------ 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/modules/ipops/README b/modules/ipops/README index cd61bb0..a0250a5 100644 --- a/modules/ipops/README +++ b/modules/ipops/README @@ -76,8 +76,8 @@ Chapter 1. Admin Guide 1. Overview - This module offers operations for handling IP addresses in both IPv4 - and IPv6. + This module offers operations for handling IP addresses, both IPv4 and + IPv6. IPv6 is defined in RFC 2460. The same IPv6 address can be represented by different ASCII strings, so binary comparison is required. For @@ -131,7 +131,8 @@ Chapter 1. Admin Guide FALSE otherwise. Parameters: - * ip - String or pseudo-variable containing the IP to evaluate. + * ip - String or pseudo-variable containing the IP address to + evaluate. This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE. @@ -251,7 +252,8 @@ switch($rc) { 4.7. compare_ips (ip1, ip2) Returns TRUE if both IP addresses are the same. FALSE otherwise. This - function also allows comparing an IPv6 against an IPv6 reference. + function also allows comparing an IPv6 address against an IPv6 + reference. Parameters: * ip1 - String or pseudo-variable containing the first IP to compare. @@ -275,8 +277,9 @@ if (compare_ips("1080:0000:0000:0000:0008:0800:200C:417A", "[1080::8:800:200C:41 does NOT allow comparing an IPv6 against an IPv6 reference. Parameters: - * ip1 - String or pseudo-variable containing the first IP to compare. - * ip2 - String or pseudo-variable containing the second IP to + * ip1 - String or pseudo-variable containing the first IP address to + compare. + * ip2 - String or pseudo-variable containing the second IP address to compare. This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, diff --git a/modules/ipops/doc/ipops_admin.xml b/modules/ipops/doc/ipops_admin.xml index 317d86b..8cbeac2 100644 --- a/modules/ipops/doc/ipops_admin.xml +++ b/modules/ipops/doc/ipops_admin.xml @@ -19,9 +19,8 @@ <title>Overview</title> <para> - This module offers operations for handling IP addresses in both IPv4 and IPv6. + This module offers operations for handling IP addresses, both IPv4 and IPv6. </para> - <para> IPv6 is defined in <ulink url="http://tools.ietf.org/html/rfc2460">RFC 2460</ulink>. The same IPv6 address can be represented by different ASCII strings, so binary comparison is required. @@ -108,7 +107,7 @@ <itemizedlist> <listitem> <para> - <emphasis>ip</emphasis> - String or pseudo-variable containing the IP to evaluate. + <emphasis>ip</emphasis> - String or pseudo-variable containing the IP address to evaluate. </para> </listitem> </itemizedlist> @@ -367,7 +366,7 @@ switch($rc) { <para> Returns TRUE if both IP addresses are the same. FALSE otherwise. - This function also allows comparing an IPv6 against an IPv6 reference. + This function also allows comparing an IPv6 address against an IPv6 reference. </para> <para>Parameters:</para> @@ -419,12 +418,12 @@ if (compare_ips("1080:0000:0000:0000:0008:0800:200C:417A", "[1080::8:800:200C:41 <itemizedlist> <listitem> <para> - <emphasis>ip1</emphasis> - String or pseudo-variable containing the first IP to compare. + <emphasis>ip1</emphasis> - String or pseudo-variable containing the first IP address to compare. </para> </listitem> <listitem> <para> - <emphasis>ip2</emphasis> - String or pseudo-variable containing the second IP to compare. + <emphasis>ip2</emphasis> - String or pseudo-variable containing the second IP address to compare. </para> </listitem> </itemizedlist>