svn: /pear/peardoc/trunk/en/package/networking/net-ipv6/ compress.xml getprefixlength.xml removeprefixlength.xml uncompress.xml

alexmerz                                 Thu, 30 Dec 2010 04:32:28 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=306842

Log:
update compress() and uncompress() docs, mark getPrefixLength() and removePrefixLength as deprecated

Changed paths:
    U   pear/peardoc/trunk/en/package/networking/net-ipv6/compress.xml
    U   pear/peardoc/trunk/en/package/networking/net-ipv6/getprefixlength.xml
    U   pear/peardoc/trunk/en/package/networking/net-ipv6/removeprefixlength.xml
    U   pear/peardoc/trunk/en/package/networking/net-ipv6/uncompress.xml

Modified: pear/peardoc/trunk/en/package/networking/net-ipv6/compress.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-ipv6/compress.xml	2010-12-30 04:09:17 UTC (rev 306841)
+++ pear/peardoc/trunk/en/package/networking/net-ipv6/compress.xml	2010-12-30 04:32:28 UTC (rev 306842)
@@ -12,6 +12,7 @@
     <funcprototype>
      <funcdef>string <function>Net_IPv6::compress</function></funcdef>
      <paramdef choice="req">string <parameter>$ip</parameter></paramdef>
+     <paramdef choice="opt">boolean <parameter>$force = false</parameter></paramdef>
     </funcprototype>
     </funcsynopsis>
    </refsynopsisdiv>
@@ -27,6 +28,15 @@
       0:0:0:0:0:0:0:1      -&gt; ::1
      </programlisting>
     </para>
+    <para>
+	 By default, the method does not touch an already compressed address and returns the address as is.
+     This happens also in case of an address that is compressed but can be compressed further,
+     for example an address like FF01::0:1 will be returned as is.
+    </para>
+    <para>
+     Since version 1.2.1, you can change this behavoir to enforce compression by setting
+     <parameter>$force</parameter> to true.
+    </para>
    </refsection>
    <refsection xml:id="package.networking.net-ipv6.compress.parameter">
     &title.param;
@@ -37,6 +47,12 @@
         <parameter>string $ip</parameter> - the IP address to compress
        </para>
       </listitem>
+      <listitem>
+       <para>
+        <parameter>boolean $force</parameter> - if true, an already compressed
+        IP address will be compressed again
+       </para>
+      </listitem>
      </itemizedlist>
     </para>
    </refsection>

Modified: pear/peardoc/trunk/en/package/networking/net-ipv6/getprefixlength.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-ipv6/getprefixlength.xml	2010-12-30 04:09:17 UTC (rev 306841)
+++ pear/peardoc/trunk/en/package/networking/net-ipv6/getprefixlength.xml	2010-12-30 04:32:28 UTC (rev 306842)
@@ -47,5 +47,9 @@
     <simpara>
      Method available since: Release 1.1.0
     </simpara>
+    &note.deprecated;
+    <para>
+     Deprecated in release 1.2.1
+    </para>
    </refsection>
   </refentry>

Modified: pear/peardoc/trunk/en/package/networking/net-ipv6/removeprefixlength.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-ipv6/removeprefixlength.xml	2010-12-30 04:09:17 UTC (rev 306841)
+++ pear/peardoc/trunk/en/package/networking/net-ipv6/removeprefixlength.xml	2010-12-30 04:32:28 UTC (rev 306842)
@@ -47,5 +47,9 @@
     <simpara>
      Method available since: Release 1.1.0
     </simpara>
+    &note.deprecated;
+    <para>
+     Deprecated in release 1.2.1
+    </para>
    </refsection>
   </refentry>

Modified: pear/peardoc/trunk/en/package/networking/net-ipv6/uncompress.xml
===================================================================
--- pear/peardoc/trunk/en/package/networking/net-ipv6/uncompress.xml	2010-12-30 04:09:17 UTC (rev 306841)
+++ pear/peardoc/trunk/en/package/networking/net-ipv6/uncompress.xml	2010-12-30 04:32:28 UTC (rev 306842)
@@ -12,6 +12,7 @@
     <funcprototype>
      <funcdef>string <function>Net_IPv6::uncompress</function></funcdef>
      <paramdef choice="req">string <parameter>$ip</parameter></paramdef>
+     <paramdef choice="opt">boolean <parameter>$leadingZeros = false</parameter></paramdef>
     </funcprototype>
     </funcsynopsis>
    </refsynopsisdiv>
@@ -27,6 +28,11 @@
       ::1       -&gt;  0:0:0:0:0:0:0:1
      </programlisting>
     </para>
+    <para>
+     Since version 1.2.1, the method can return the address in a nice format where each part of the
+     address has a fixed length of 4 characters. To enable this, you must set
+     <parameter>$leadingZeros</parameter> to true.
+    </para>
    </refsection>
    <refsection xml:id="package.networking.net-ipv6.uncompress.parameter">
     &title.param;
@@ -37,7 +43,13 @@
         <parameter>string $ip</parameter> - the IP address to uncompress
        </para>
       </listitem>
-     </itemizedlist>
+      <listitem>
+       <para>
+        <parameter>boolean $leadingZeros</parameter> - if true, the uncompressed address
+        has a fixed length
+       </para>
+      </listitem>
+      </itemizedlist>
     </para>
    </refsection>
    <refsection xml:id="package.networking.net-ipv6.uncompress.return">