Added xdiff documentation. Correction of errors is probably needed...

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@150863 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Marcin Gibula 2004-02-09 17:51:22 +00:00
parent 20857c0250
commit 2a2d2e1b76
13 changed files with 700 additions and 0 deletions

View file

@ -0,0 +1,52 @@
<?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 id="function.xdiff-file-diff-binary">
<refnamediv>
<refname>xdiff_file_diff_binary</refname>
<refpurpose>
Make binary diff of two files.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>xdiff_file_diff</methodname>
<methodparam><type>string</type><parameter>file1</parameter></methodparam>
<methodparam><type>string</type><parameter>file2</parameter></methodparam>
<methodparam><type>string</type><parameter>dest</parameter></methodparam>
</methodsynopsis>
<para>
<function>xdiff_file_diff_binary</function> makes binary diff of files
<parameter>file1</parameter> and <parameter>file2</parameter> and stores
result in file <parameter>dest</parameter>.
</para>
<para>
Returns &true; or &false; if and internal error happened.
</para>
<para>
See also <function>xdiff_string_diff_binary</function>.
</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
-->

View file

@ -0,0 +1,57 @@
<?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 id="function.xdiff-file-diff">
<refnamediv>
<refname>xdiff_file_diff</refname>
<refpurpose>
Make unified diff of two files.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>xdiff_file_diff</methodname>
<methodparam><type>string</type><parameter>file1</parameter></methodparam>
<methodparam><type>string</type><parameter>file2</parameter></methodparam>
<methodparam><type>string</type><parameter>dest</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>context</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>minimal</parameter></methodparam>
</methodsynopsis>
<para>
<function>xdiff_file_diff</function> makes unified diff of files
<parameter>file1</parameter> and <parameter>file2</parameter> and stores
result in file <parameter>dest</parameter>.
<parameter>context</parameter> indicated how many lines of context you
want to include in diff result. Set <parameter>minimal</parameter> to
&true; if you want to minimalize size of diff (can take a long time).
</para>
<para>
Returns &true; or &false; if and internal error happened.
</para>
<para>
See also <function>xdiff_string_diff</function>.
</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
-->

View file

@ -0,0 +1,55 @@
<?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 id="function.xdiff-file-merge3">
<refnamediv>
<refname>xdiff_file_merge3</refname>
<refpurpose>
Merge 3 files into one.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>xdiff_file_merge3</methodname>
<methodparam><type>string</type><parameter>file1</parameter></methodparam>
<methodparam><type>string</type><parameter>file2</parameter></methodparam>
<methodparam><type>string</type><parameter>file3</parameter></methodparam>
<methodparam><type>string</type><parameter>dest</parameter></methodparam>
</methodsynopsis>
<para>
<function>xdiff_file_merge3</function> merges files
<parameter>file1</parameter>, <parameter>file2</parameter> and
<parameter>file3</parameter> into one and stores result in file
<parameter>dest</parameter>.
</para>
<para>
Returns &true; if merge was successful, string with rejected chunks if
it was not or &false; if an internal error happened.
</para>
<para>
See also <function>xdiff_strings_merge3</function>.
</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
-->

View file

@ -0,0 +1,53 @@
<?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 id="function.xdiff-file-patch-binary">
<refnamediv>
<refname>xdiff_file_patch_binary</refname>
<refpurpose>
Patch a file with a binary diff.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>xdiff_file_patch_binary</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>
<function>xdiff_file_patch_binary</function> patches file
<parameter>file</parameter> with binary patch in file
<parameter>patch</parameter> and stores result in file
<parameter>dest</parameter>.
</para>
<para>
Returns &true; or &false; if an internal error happened.
</para>
<para>
See also <function>xdiff_string_patch_binary</function>.
</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
-->

View file

@ -0,0 +1,60 @@
<?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 id="function.xdiff-file-patch">
<refnamediv>
<refname>xdiff_file_patch</refname>
<refpurpose>
Patch a file with an unified diff.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>xdiff_file_patch</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>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
<function>xdiff_file_patch</function> patches file
<parameter>file</parameter> with unified patch in file
<parameter>patch</parameter> and stores result in file
<parameter>dest</parameter>.
</para>
<para>
<parameter>flags</parameter> can be either
<constant>XDIFF_PATCH_NORMAL</constant> (default mode, normal patch) or
<constant>XDIFF_PATCH_REVERSE</constant> (reversed patch).
</para>
<para>
Returns &false; if an internal error happened, string with rejected
chunks of patch or &true; if patch has been successfully applied.
</para>
<para>
See also <function>xdiff_string_patch</function>.
</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
-->

View file

@ -0,0 +1,50 @@
<?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 id="function.xdiff-string-diff-binary">
<refnamediv>
<refname>xdiff_string_diff_binary</refname>
<refpurpose>
Make binary diff of two strings.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>xdiff_string_diff</methodname>
<methodparam><type>string</type><parameter>str1</parameter></methodparam>
<methodparam><type>string</type><parameter>str2</parameter></methodparam>
</methodsynopsis>
<para>
<function>xdiff_string_diff_binary</function> makes binary diff of
strings <parameter>str1</parameter> and <parameter>str2</parameter>.
</para>
<para>
Returns string with result or &false; if and internal error happened.
</para>
<para>
See also <function>xdiff_file_diff_binary</function>.
</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
-->

View file

@ -0,0 +1,55 @@
<?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 id="function.xdiff-string-diff">
<refnamediv>
<refname>xdiff_string_diff</refname>
<refpurpose>
Make unified diff of two strings.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>xdiff_string_diff</methodname>
<methodparam><type>string</type><parameter>str1</parameter></methodparam>
<methodparam><type>string</type><parameter>str2</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>context</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>minimal</parameter></methodparam>
</methodsynopsis>
<para>
<function>xdiff_string_diff</function> makes unified diff of strings
<parameter>str1</parameter> and <parameter>str2</parameter>.
<parameter>context</parameter> indicated how many lines of context you
want to include in diff result. Set <parameter>minimal</parameter> to
&true; if you want to minimalize size of diff (can take a long time).
</para>
<para>
Returns string with result or &false; if and internal error happened.
</para>
<para>
See also <function>xdiff_file_diff</function>.
</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
-->

View file

@ -0,0 +1,57 @@
<?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 id="function.xdiff-string-merge3">
<refnamediv>
<refname>xdiff_string_merge3</refname>
<refpurpose>
Merge 3 strings into one.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>xdiff_string_merge3</methodname>
<methodparam><type>string</type><parameter>str1</parameter></methodparam>
<methodparam><type>string</type><parameter>str2</parameter></methodparam>
<methodparam><type>string</type><parameter>str3</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>&amp; error</parameter></methodparam>
</methodsynopsis>
<para>
<function>xdiff_string_merge3</function>merges strings
<parameter>str1</parameter>, <parameter>str2</parameter> and
<parameter>str3</parameter> into one.
</para>
<para>
If <parameter>error</parameter> is passed then rejected parts are stored
inside this variable.
</para>
<para>
Returns merged string or &false; if an internal error happened.
</para>
<para>
See also <function>xdiff_file_merge3</function>.
</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
-->

View file

@ -0,0 +1,51 @@
<?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 id="function.xdiff-string-patch-binary">
<refnamediv>
<refname>xdiff_string_patch_binary</refname>
<refpurpose>
Patch a string with a binary diff.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>xdiff_string_patch_binary</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>string</type><parameter>patch</parameter></methodparam>
</methodsynopsis>
<para>
<function>xdiff_string_patch_binary</function> patches string
<parameter>str</parameter> with binary patch in string
<parameter>patch</parameter>.
</para>
<para>
Returns a patched string.
</para>
<para>
See also <function>xdiff_file_patch_binary</function>.
</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
-->

View file

@ -0,0 +1,62 @@
<?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 id="function.xdiff-string-patch">
<refnamediv>
<refname>xdiff_string_patch</refname>
<refpurpose>
Patch a string with an unified diff.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>xdiff_string_patch</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>string</type><parameter>patch</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>&amp; error</parameter></methodparam>
</methodsynopsis>
<para>
<function>xdiff_string_patch</function> patches string
<parameter>str</parameter> with unified patch in string
<parameter>patch</parameter>.
</para>
<para>
<parameter>flags</parameter> can be either
<constant>XDIFF_PATCH_NORMAL</constant> (default mode, normal patch) or
<constant>XDIFF_PATCH_REVERSE</constant> (reversed patch).
</para>
<para>
If <parameter>error</parameter> is passed then rejected parts are stored
inside this variable.
</para>
<para>
Returns a patched string.
</para>
<para>
See also <function>xdiff_file_patch</function>.
</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
-->

View file

@ -0,0 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="xdiff.installation">
&reftitle.install;
<para>
xdiff is currently available through PECL
<ulink url="&url.pecl.package;xdiff">&url.pecl.package;xdiff</ulink>.
</para>
<para>
If <ulink url="&url.php.pear;">PEAR</ulink> is available on your *nix-like
system you can use the pear installer to install the xdiff extension, by the
following command: <command>pear -v install xdiff</command>.
</para>
<para>
You can always download the tar.gz package and install xdiff by hand:
<example>
<title>xdiff install by hand</title>
<programlisting role="shell">
<![CDATA[
gunzip xdiff-xxx.tgz
tar -xvf xdiff-xxx.tar
cd xdiff-xxx
phpize
./configure && make && make install
]]>
</programlisting>
</example>
</para>
</section>
<!-- 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
-->

View file

@ -0,0 +1,48 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="xdiff.constants">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry>
<term>
<constant>XDIFF_PATCH_NORMAL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>XDIFF_PATCH_REVERSE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- 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:
-->

View file

@ -0,0 +1,50 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<reference id="ref.xdiff">
<title>xdiff Functions</title>
<titleabbrev>xdiff</titleabbrev>
<partintro>
<section id="xdiff.intro">
&reftitle.intro;
<para>
xdiff extension creates and applies patches to both text and binary files.
</para>
</section>
<section id="xdiff.requirements">
&reftitle.required;
<para>
To use xdiff, you will need libxdiff installed, available
on the libxdiff homepage <ulink url="&url.xdiff;">&url.xdiff;</ulink>.
</para>
</section>
&reference.xdiff.configure;
&reference.xdiff.constants;
</partintro>
&reference.xdiff.functions;
</reference>
<!-- 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
-->