cvs: phpdoc /en/reference/xdiff book.xml /en/reference/xdiff/functions xdiff-file-bdiff-size.xml xdiff-file-bdiff.xml xdiff-file-bpatch.xml
xdiff-file-rabdiff.xml xdiff-string-bdiff-size.xml xdiff-string-bdiff.xml xdiff-string-bpatch.xml xdiff-string-rabdiff.xml

From: Date: Thu, 03 Jul 2008 16:41:16 +0000
Subject: cvs: phpdoc /en/reference/xdiff book.xml /en/reference/xdiff/functions xdiff-file-bdiff-size.xml xdiff-file-bdiff.xml xdiff-file-bpatch.xml
xdiff-file-rabdiff.xml xdiff-string-bdiff-size.xml xdiff-string-bdiff.xml xdiff-string-bpatch.xml xdiff-string-rabdiff.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-1827@lists.php.net to get a copy of this message
mg Thu Jul 3 16:41:16 2008 UTC Added files: /phpdoc/en/reference/xdiff/functions xdiff-file-bdiff-size.xml xdiff-file-bdiff.xml xdiff-file-bpatch.xml xdiff-file-rabdiff.xml xdiff-string-bdiff-size.xml xdiff-string-bdiff.xml xdiff-string-bpatch.xml xdiff-string-rabdiff.xml Modified files: /phpdoc/en/reference/xdiff book.xml Log: New functions documentation added.

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/book.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/xdiff/book.xml diff -u phpdoc/en/reference/xdiff/book.xml:1.4 phpdoc/en/reference/xdiff/book.xml:1.5 --- phpdoc/en/reference/xdiff/book.xml:1.4 Thu Jul 3 16:15:25 2008 +++ phpdoc/en/reference/xdiff/book.xml Thu Jul 3 16:41:16 2008 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- Purpose: basic.text --> <!-- Membership: pecl, external --> @@ -26,7 +26,7 @@ <function>xdiff_file_rabdiff</function> generate output compatible with older functions but are typically faster and generate smaller results. For more details about methods of generating binary patches and differences between them, please check - <link xlink:href="&url.xdiff;">libxdiff</link> site. + <link xlink:href="&url.xdiff;">libxdiff</link> website. </para> <para> This extension uses libxdiff to implement these functions. Please see http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-bdiff-size.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/xdiff/functions/xdiff-file-bdiff-size.xml +++ phpdoc/en/reference/xdiff/functions/xdiff-file-bdiff-size.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry xml:id="function.xdiff-file-bdiff-size" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>xdiff_file_bdiff_size</refname> <refpurpose>Read a size of file created by applying a binary diff</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>long</type><methodname>xdiff_file_bdiff_size</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> </methodsynopsis> <para> Returns a size of a result file that would be created after applying binary patch from file <parameter>file</parameter> to the original file. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>file</parameter></term> <listitem> <para> The path to the binary patch created by <function>xdiff_string_bdiff</function> or <function>xdiff_string_rabdiff</function> function. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the size of file that would be created. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>xdiff_file_bdiff_size</function> example</title> <para> The following code applies reads a size of file that would be created after applying a binary diff. </para> <programlisting role="php"> <![CDATA[ <?php $length = xdiff_string_bdiff_size('file.bdiff'); echo "Resulting file will be $length bytes long"; ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>xdiff_file_bdiff</function></member> <member><function>xdiff_file_rabdiff</function></member> <member><function>xdiff_file_bpatch</function></member> </simplelist> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-bdiff.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/xdiff/functions/xdiff-file-bdiff.xml +++ phpdoc/en/reference/xdiff/functions/xdiff-file-bdiff.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry xml:id="function.xdiff-file-bdiff" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>xdiff_file_bdiff</refname> <refpurpose>Make binary diff of two files</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>xdiff_file_bdiff</methodname> <methodparam><type>string</type><parameter>old_file</parameter></methodparam> <methodparam><type>string</type><parameter>new_file</parameter></methodparam> <methodparam><type>string</type><parameter>dest</parameter></methodparam> </methodsynopsis> <para> Makes a binary diff of two files and stores the result in a patch file. This function works with both text and binary files. Resulting patch file can be later applied using <function>xdiff_file_bpatch</function>/<function>xdiff_string_bpatch</function>. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>old_file</parameter></term> <listitem> <para> Path to the first file. This file acts as "old" file. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>new_file</parameter></term> <listitem> <para> Path to the second file. This file acts as "new" file. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>dest</parameter></term> <listitem> <para> Path of the resulting patch file. Resulting file containts differences between "old" and "new" files. It is in binary format and is human-unreadable. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>xdiff_file_bdiff</function> example</title> <para> The following code makes binary diff of two archives. </para> <programlisting role="php"> <![CDATA[ <?php $old_version = 'my_script_1.0.tgz'; $new_version = 'my_script_1.1.tgz'; xdiff_file_bdiff($old_version, $new_version, 'my_script.bdiff'); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="notes"> &reftitle.notes; <note> <para> Both files will be loaded into memory so ensure that your memory_limit is set high enough. </para> </note> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>xdiff_file_bpatch</function></member> </simplelist> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-bpatch.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/xdiff/functions/xdiff-file-bpatch.xml +++ phpdoc/en/reference/xdiff/functions/xdiff-file-bpatch.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry xml:id="function.xdiff-file-bpatch" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>xdiff_file_bpatch</refname> <refpurpose>Patch a file with a binary diff</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>xdiff_file_bpatch</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> <methodparam><type>string</type><parameter>patch</parameter></methodparam> <methodparam><type>string</type><parameter>dest</parameter></methodparam> </methodsynopsis> <para> Patches a <parameter>file</parameter> with a binary <parameter>patch</parameter> and stores the result in a file <parameter>dest</parameter>. This function accepts patches created both via <function>xdiff_file_bdiff</function> and <function>xdiff_file_rabdiff</function> functions or their string counterparts. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>file</parameter></term> <listitem> <para> The original file. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>patch</parameter></term> <listitem> <para> The binary patch file. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>dest</parameter></term> <listitem> <para> Path of the resulting file. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>xdiff_file_bpatch</function> example</title> <para> The following code applies binary diff to a file. </para> <programlisting role="php"> <![CDATA[ <?php $old_version = 'archive-1.0.tgz'; $patch = 'archive.bpatch'; $result = xdiff_file_bpatch($old_version, $patch, 'archive-1.1.tgz'); if ($result) { echo "File patched"; } else { echo "File couldn't be patched"; } ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="notes"> &reftitle.notes; <note> <para> Both files (<parameter>file</parameter> and <parameter>patch</parameter>) will be loaded into memory so ensure that your memory_limit is set high enough. </para> </note> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>xdiff_file_bdiff</function></member> <member><function>xdiff_file_rabdiff</function></member> </simplelist> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-rabdiff.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/xdiff/functions/xdiff-file-rabdiff.xml +++ phpdoc/en/reference/xdiff/functions/xdiff-file-rabdiff.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry xml:id="function.xdiff-file-rabdiff" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>xdiff_file_rabdiff</refname> <refpurpose>Make binary diff of two files using the Rabin's polynomial fingerprinting algorithm</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>bool</type><methodname>xdiff_file_rabdiff</methodname> <methodparam><type>string</type><parameter>old_file</parameter></methodparam> <methodparam><type>string</type><parameter>new_file</parameter></methodparam> <methodparam><type>string</type><parameter>dest</parameter></methodparam> </methodsynopsis> <para> Makes a binary diff of two files and stores the result in a patch file. The difference between this function and <function>xdiff_file_bdiff</function> is different algorithm used which should result in faster execution and smaller diff produced. This function works with both text and binary files. Resulting patch file can be later applied using <function>xdiff_file_bpatch</function>/<function>xdiff_string_bpatch</function>. </para> <para> For more details about differences between algorithm used please check <link xlink:href="&url.xdiff;">libxdiff</link> website. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>old_file</parameter></term> <listitem> <para> Path to the first file. This file acts as "old" file. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>new_file</parameter></term> <listitem> <para> Path to the second file. This file acts as "new" file. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>dest</parameter></term> <listitem> <para> Path of the resulting patch file. Resulting file containts differences between "old" and "new" files. It is in binary format and is human-unreadable. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> &return.success; </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>xdiff_file_rabdiff</function> example</title> <para> The following code makes binary diff of two archives. </para> <programlisting role="php"> <![CDATA[ <?php $old_version = 'my_script_1.0.tgz'; $new_version = 'my_script_1.1.tgz'; xdiff_file_rabdiff($old_version, $new_version, 'my_script.bdiff'); ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="notes"> &reftitle.notes; <note> <para> Both files will be loaded into memory so ensure that your memory_limit is set high enough. </para> </note> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>xdiff_file_bpatch</function></member> </simplelist> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-bdiff-size.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/xdiff/functions/xdiff-string-bdiff-size.xml +++ phpdoc/en/reference/xdiff/functions/xdiff-string-bdiff-size.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry xml:id="function.xdiff-string-bdiff-size" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>xdiff_string_bdiff_size</refname> <refpurpose>Read a size of file created by applying a binary diff</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>long</type><methodname>xdiff_string_bdiff_size</methodname> <methodparam><type>string</type><parameter>patch</parameter></methodparam> </methodsynopsis> <para> Returns a size of a result file that would be created after applying binary <parameter>patch</parameter> to the original file. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>patch</parameter></term> <listitem> <para> The binary patch created by <function>xdiff_string_bdiff</function> or <function>xdiff_string_rabdiff</function> function. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the size of file that would be created. </para> </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> <example> <title><function>xdiff_string_bdiff_size</function> example</title> <para> The following code applies reads a size of file that would be created after applying a binary diff. </para> <programlisting role="php"> <![CDATA[ <?php $binary_patch = file_get_contents('file.bdiff'); $length = xdiff_string_bdiff_size($binary_patch); echo "Resulting file will be $length bytes long"; ?> ]]> </programlisting> </example> </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>xdiff_string_bdiff</function></member> <member><function>xdiff_string_rabdiff</function></member> <member><function>xdiff_string_bpatch</function></member> </simplelist> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-bdiff.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/xdiff/functions/xdiff-string-bdiff.xml +++ phpdoc/en/reference/xdiff/functions/xdiff-string-bdiff.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry xml:id="function.xdiff-string-bdiff" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>xdiff_string_bdiff</refname> <refpurpose>Make binary diff of two strings</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>xdiff_string_bdiff</methodname> <methodparam><type>string</type><parameter>old_data</parameter></methodparam> <methodparam><type>string</type><parameter>new_data</parameter></methodparam> </methodsynopsis> <para> Makes a binary diff of two strings and returns the result. This function works with both text and binary data. Resulting patch can be later applied using <function>xdiff_string_bpatch</function>/<function>xdiff_file_bpatch</function>. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>old_data</parameter></term> <listitem> <para> First string with binary data. It acts as "old" data. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>new_data</parameter></term> <listitem> <para> Second string with binary data. It acts as "new" data. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns string with binary diff containing differences between "old" and "new" data or &false; if an internal error occured. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>xdiff_string_bpatch</function></member> </simplelist> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-bpatch.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/xdiff/functions/xdiff-string-bpatch.xml +++ phpdoc/en/reference/xdiff/functions/xdiff-string-bpatch.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry xml:id="function.xdiff-string-bpatch" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>xdiff_string_bpatch</refname> <refpurpose>Patch a string with a binary diff</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>xdiff_string_bpatch</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> <methodparam><type>string</type><parameter>patch</parameter></methodparam> </methodsynopsis> <para> Patches a string <parameter>str</parameter> with a binary <parameter>patch</parameter>. This function accepts patches created both via <function>xdiff_string_bdiff</function> and <function>xdiff_string_rabdiff</function> functions or their file counterparts. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>str</parameter></term> <listitem> <para> The original binary string. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>patch</parameter></term> <listitem> <para> The binary patch string. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the patched string, or &false; on error. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>xdiff_string_bdiff</function></member> <member><function>xdiff_string_rabdiff</function></member> </simplelist> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-rabdiff.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/xdiff/functions/xdiff-string-rabdiff.xml +++ phpdoc/en/reference/xdiff/functions/xdiff-string-rabdiff.xml <?xml version='1.0' encoding='iso-8859-1'?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry xml:id="function.xdiff-string-rabdiff" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>xdiff_string_rabdiff</refname> <refpurpose>Make binary diff of two strings using the Rabin's polynomial fingerprinting algorithm</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>xdiff_string_bdiff</methodname> <methodparam><type>string</type><parameter>old_data</parameter></methodparam> <methodparam><type>string</type><parameter>new_data</parameter></methodparam> </methodsynopsis> <para> Makes a binary diff of two strings and returns the result. The difference between this function and <function>xdiff_string_bdiff</function> is different algorithm used which should result in faster execution and smaller diff produced. This function works with both text and binary data. Resulting patch can be later applied using <function>xdiff_string_bpatch</function>/<function>xdiff_file_bpatch</function>. </para> <para> For more details about differences between algorithm used please check <link xlink:href="&url.xdiff;">libxdiff</link> website. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>old_data</parameter></term> <listitem> <para> First string with binary data. It acts as "old" data. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>new_data</parameter></term> <listitem> <para> Second string with binary data. It acts as "new" data. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns string with binary diff containing differences between "old" and "new" data or &false; if an internal error occured. </para> </refsect1> <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> <member><function>xdiff_string_bpatch</function></member> </simplelist> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->
« previous php.doc.cvs (#1827) next »