فهرست منبع

ipops Minor updates to README

Olle E. Johansson 12 سال پیش
والد
کامیت
a9ca3f4a05
2فایلهای تغییر یافته به همراه14 افزوده شده و 12 حذف شده
  1. 9 6
      modules/ipops/README
  2. 5 6
      modules/ipops/doc/ipops_admin.xml

+ 9 - 6
modules/ipops/README

@@ -76,8 +76,8 @@ Chapter 1. Admin Guide
 
 
 1. Overview
 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
    IPv6 is defined in RFC 2460. The same IPv6 address can be represented
    by different ASCII strings, so binary comparison is required. For
    by different ASCII strings, so binary comparison is required. For
@@ -131,7 +131,8 @@ Chapter 1. Admin Guide
    FALSE otherwise.
    FALSE otherwise.
 
 
    Parameters:
    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,
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
    ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
@@ -251,7 +252,8 @@ switch($rc) {
 4.7.  compare_ips (ip1, ip2)
 4.7.  compare_ips (ip1, ip2)
 
 
    Returns TRUE if both IP addresses are the same. FALSE otherwise. This
    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:
    Parameters:
      * ip1 - String or pseudo-variable containing the first IP to compare.
      * 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.
    does NOT allow comparing an IPv6 against an IPv6 reference.
 
 
    Parameters:
    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.
        compare.
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,

+ 5 - 6
modules/ipops/doc/ipops_admin.xml

@@ -19,9 +19,8 @@
     <title>Overview</title>
     <title>Overview</title>
          
          
     <para>
     <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>
-
     <para>
     <para>
       IPv6 is defined in <ulink url="http://tools.ietf.org/html/rfc2460">RFC 2460</ulink>.
       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.
 	The same IPv6 address can be represented by different ASCII strings, so binary comparison is required.
@@ -108,7 +107,7 @@
       <itemizedlist>
       <itemizedlist>
         <listitem>
         <listitem>
           <para>
           <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>
           </para>
         </listitem>
         </listitem>
       </itemizedlist>
       </itemizedlist>
@@ -367,7 +366,7 @@ switch($rc) {
 
 
       <para>
       <para>
         Returns TRUE if both IP addresses are the same. FALSE otherwise.
         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>
 
 
       <para>Parameters:</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>
       <itemizedlist>
         <listitem>
         <listitem>
           <para>
           <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>
           </para>
         </listitem>
         </listitem>
         <listitem>
         <listitem>
           <para>
           <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>
           </para>
         </listitem>
         </listitem>
       </itemizedlist>
       </itemizedlist>