From 2a2d2e1b769b747f10014fd08304875699674ff9 Mon Sep 17 00:00:00 2001 From: Marcin Gibula Date: Mon, 9 Feb 2004 17:51:22 +0000 Subject: [PATCH] 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 --- .../lzf/functions/xdiff-file-diff-binary.xml | 52 ++++++++++++++++ reference/lzf/functions/xdiff-file-diff.xml | 57 +++++++++++++++++ reference/lzf/functions/xdiff-file-merge3.xml | 55 ++++++++++++++++ .../lzf/functions/xdiff-file-patch-binary.xml | 53 ++++++++++++++++ reference/lzf/functions/xdiff-file-patch.xml | 60 ++++++++++++++++++ .../functions/xdiff-string-diff-binary.xml | 50 +++++++++++++++ reference/lzf/functions/xdiff-string-diff.xml | 55 ++++++++++++++++ .../lzf/functions/xdiff-string-merge3.xml | 57 +++++++++++++++++ .../functions/xdiff-string-patch-binary.xml | 51 +++++++++++++++ .../lzf/functions/xdiff-string-patch.xml | 62 +++++++++++++++++++ reference/xdiff/configure.xml | 50 +++++++++++++++ reference/xdiff/constants.xml | 48 ++++++++++++++ reference/xdiff/reference.xml | 50 +++++++++++++++ 13 files changed, 700 insertions(+) create mode 100644 reference/lzf/functions/xdiff-file-diff-binary.xml create mode 100644 reference/lzf/functions/xdiff-file-diff.xml create mode 100644 reference/lzf/functions/xdiff-file-merge3.xml create mode 100644 reference/lzf/functions/xdiff-file-patch-binary.xml create mode 100644 reference/lzf/functions/xdiff-file-patch.xml create mode 100644 reference/lzf/functions/xdiff-string-diff-binary.xml create mode 100644 reference/lzf/functions/xdiff-string-diff.xml create mode 100644 reference/lzf/functions/xdiff-string-merge3.xml create mode 100644 reference/lzf/functions/xdiff-string-patch-binary.xml create mode 100644 reference/lzf/functions/xdiff-string-patch.xml create mode 100644 reference/xdiff/configure.xml create mode 100644 reference/xdiff/constants.xml create mode 100644 reference/xdiff/reference.xml diff --git a/reference/lzf/functions/xdiff-file-diff-binary.xml b/reference/lzf/functions/xdiff-file-diff-binary.xml new file mode 100644 index 0000000000..c60f846367 --- /dev/null +++ b/reference/lzf/functions/xdiff-file-diff-binary.xml @@ -0,0 +1,52 @@ + + + + + + xdiff_file_diff_binary + + Make binary diff of two files. + + + + Description + + boolxdiff_file_diff + stringfile1 + stringfile2 + stringdest + + + xdiff_file_diff_binary makes binary diff of files + file1 and file2 and stores + result in file dest. + + + Returns &true; or &false; if and internal error happened. + + + See also xdiff_string_diff_binary. + + + + + diff --git a/reference/lzf/functions/xdiff-file-diff.xml b/reference/lzf/functions/xdiff-file-diff.xml new file mode 100644 index 0000000000..b33dd4e395 --- /dev/null +++ b/reference/lzf/functions/xdiff-file-diff.xml @@ -0,0 +1,57 @@ + + + + + + xdiff_file_diff + + Make unified diff of two files. + + + + Description + + boolxdiff_file_diff + stringfile1 + stringfile2 + stringdest + intcontext + boolminimal + + + xdiff_file_diff makes unified diff of files + file1 and file2 and stores + result in file dest. + context indicated how many lines of context you + want to include in diff result. Set minimal to + &true; if you want to minimalize size of diff (can take a long time). + + + Returns &true; or &false; if and internal error happened. + + + See also xdiff_string_diff. + + + + + diff --git a/reference/lzf/functions/xdiff-file-merge3.xml b/reference/lzf/functions/xdiff-file-merge3.xml new file mode 100644 index 0000000000..99600a90d3 --- /dev/null +++ b/reference/lzf/functions/xdiff-file-merge3.xml @@ -0,0 +1,55 @@ + + + + + + xdiff_file_merge3 + + Merge 3 files into one. + + + + Description + + mixedxdiff_file_merge3 + stringfile1 + stringfile2 + stringfile3 + stringdest + + + xdiff_file_merge3 merges files + file1, file2 and + file3 into one and stores result in file + dest. + + + Returns &true; if merge was successful, string with rejected chunks if + it was not or &false; if an internal error happened. + + + See also xdiff_strings_merge3. + + + + + diff --git a/reference/lzf/functions/xdiff-file-patch-binary.xml b/reference/lzf/functions/xdiff-file-patch-binary.xml new file mode 100644 index 0000000000..ff2c05cdf6 --- /dev/null +++ b/reference/lzf/functions/xdiff-file-patch-binary.xml @@ -0,0 +1,53 @@ + + + + + + xdiff_file_patch_binary + + Patch a file with a binary diff. + + + + Description + + boolxdiff_file_patch_binary + stringfile + stringpatch + stringdest + + + xdiff_file_patch_binary patches file + file with binary patch in file + patch and stores result in file + dest. + + + Returns &true; or &false; if an internal error happened. + + + See also xdiff_string_patch_binary. + + + + + diff --git a/reference/lzf/functions/xdiff-file-patch.xml b/reference/lzf/functions/xdiff-file-patch.xml new file mode 100644 index 0000000000..0cd406464d --- /dev/null +++ b/reference/lzf/functions/xdiff-file-patch.xml @@ -0,0 +1,60 @@ + + + + + + xdiff_file_patch + + Patch a file with an unified diff. + + + + Description + + mixedxdiff_file_patch + stringfile + stringpatch + stringdest + intflags + + + xdiff_file_patch patches file + file with unified patch in file + patch and stores result in file + dest. + + + flags can be either + XDIFF_PATCH_NORMAL (default mode, normal patch) or + XDIFF_PATCH_REVERSE (reversed patch). + + + Returns &false; if an internal error happened, string with rejected + chunks of patch or &true; if patch has been successfully applied. + + + See also xdiff_string_patch. + + + + + diff --git a/reference/lzf/functions/xdiff-string-diff-binary.xml b/reference/lzf/functions/xdiff-string-diff-binary.xml new file mode 100644 index 0000000000..51d892cfe5 --- /dev/null +++ b/reference/lzf/functions/xdiff-string-diff-binary.xml @@ -0,0 +1,50 @@ + + + + + + xdiff_string_diff_binary + + Make binary diff of two strings. + + + + Description + + mixedxdiff_string_diff + stringstr1 + stringstr2 + + + xdiff_string_diff_binary makes binary diff of + strings str1 and str2. + + + Returns string with result or &false; if and internal error happened. + + + See also xdiff_file_diff_binary. + + + + + diff --git a/reference/lzf/functions/xdiff-string-diff.xml b/reference/lzf/functions/xdiff-string-diff.xml new file mode 100644 index 0000000000..281b3dc775 --- /dev/null +++ b/reference/lzf/functions/xdiff-string-diff.xml @@ -0,0 +1,55 @@ + + + + + + xdiff_string_diff + + Make unified diff of two strings. + + + + Description + + mixedxdiff_string_diff + stringstr1 + stringstr2 + intcontext + boolminimal + + + xdiff_string_diff makes unified diff of strings + str1 and str2. + context indicated how many lines of context you + want to include in diff result. Set minimal to + &true; if you want to minimalize size of diff (can take a long time). + + + Returns string with result or &false; if and internal error happened. + + + See also xdiff_file_diff. + + + + + diff --git a/reference/lzf/functions/xdiff-string-merge3.xml b/reference/lzf/functions/xdiff-string-merge3.xml new file mode 100644 index 0000000000..6e9d5142bf --- /dev/null +++ b/reference/lzf/functions/xdiff-string-merge3.xml @@ -0,0 +1,57 @@ + + + + + + xdiff_string_merge3 + + Merge 3 strings into one. + + + + Description + + stringxdiff_string_merge3 + stringstr1 + stringstr2 + stringstr3 + string& error + + + xdiff_string_merge3merges strings + str1, str2 and + str3 into one. + + + If error is passed then rejected parts are stored + inside this variable. + + + Returns merged string or &false; if an internal error happened. + + + See also xdiff_file_merge3. + + + + + diff --git a/reference/lzf/functions/xdiff-string-patch-binary.xml b/reference/lzf/functions/xdiff-string-patch-binary.xml new file mode 100644 index 0000000000..26caa01f52 --- /dev/null +++ b/reference/lzf/functions/xdiff-string-patch-binary.xml @@ -0,0 +1,51 @@ + + + + + + xdiff_string_patch_binary + + Patch a string with a binary diff. + + + + Description + + stringxdiff_string_patch_binary + stringstr + stringpatch + + + xdiff_string_patch_binary patches string + str with binary patch in string + patch. + + + Returns a patched string. + + + See also xdiff_file_patch_binary. + + + + + diff --git a/reference/lzf/functions/xdiff-string-patch.xml b/reference/lzf/functions/xdiff-string-patch.xml new file mode 100644 index 0000000000..f8c2769b0e --- /dev/null +++ b/reference/lzf/functions/xdiff-string-patch.xml @@ -0,0 +1,62 @@ + + + + + + xdiff_string_patch + + Patch a string with an unified diff. + + + + Description + + stringxdiff_string_patch + stringstr + stringpatch + intflags + string& error + + + xdiff_string_patch patches string + str with unified patch in string + patch. + + + flags can be either + XDIFF_PATCH_NORMAL (default mode, normal patch) or + XDIFF_PATCH_REVERSE (reversed patch). + + + If error is passed then rejected parts are stored + inside this variable. + + + Returns a patched string. + + + See also xdiff_file_patch. + + + + + diff --git a/reference/xdiff/configure.xml b/reference/xdiff/configure.xml new file mode 100644 index 0000000000..eddc485681 --- /dev/null +++ b/reference/xdiff/configure.xml @@ -0,0 +1,50 @@ + + +
+ &reftitle.install; + + xdiff is currently available through PECL + &url.pecl.package;xdiff. + + + If PEAR is available on your *nix-like + system you can use the pear installer to install the xdiff extension, by the + following command: pear -v install xdiff. + + + You can always download the tar.gz package and install xdiff by hand: + + xdiff install by hand + + + + + +
+ + diff --git a/reference/xdiff/constants.xml b/reference/xdiff/constants.xml new file mode 100644 index 0000000000..3b3ef99f73 --- /dev/null +++ b/reference/xdiff/constants.xml @@ -0,0 +1,48 @@ + + +
+ &reftitle.constants; + &extension.constants; + + + + XDIFF_PATCH_NORMAL + (integer) + + + + + + + + + + XDIFF_PATCH_REVERSE + (integer) + + + + + + + + +
+ + diff --git a/reference/xdiff/reference.xml b/reference/xdiff/reference.xml new file mode 100644 index 0000000000..8a93f5e5ea --- /dev/null +++ b/reference/xdiff/reference.xml @@ -0,0 +1,50 @@ + + + + + xdiff Functions + xdiff + + +
+ &reftitle.intro; + + xdiff extension creates and applies patches to both text and binary files. + +
+ +
+ &reftitle.required; + + To use xdiff, you will need libxdiff installed, available + on the libxdiff homepage &url.xdiff;. + +
+ + &reference.xdiff.configure; + &reference.xdiff.constants; + +
+ &reference.xdiff.functions; +
+ +