From 6b906b465b34578f010fee7df9da9bdbd1cc87d7 Mon Sep 17 00:00:00 2001
From: lacatoire <louis-arnaud.catoire@external.drivalia.com>
Date: Wed, 12 Nov 2025 17:43:23 +0100
Subject: [PATCH 1/8] Fix incorrect function name and description for
 xdiff_string_rabdiff()

---
 .../xdiff/functions/xdiff-string-rabdiff.xml  | 99 ++++++++++++-------
 1 file changed, 64 insertions(+), 35 deletions(-)

diff --git a/reference/xdiff/functions/xdiff-string-rabdiff.xml b/reference/xdiff/functions/xdiff-string-rabdiff.xml
index 56c3ebcf0edd..f714967cb389 100644
--- a/reference/xdiff/functions/xdiff-string-rabdiff.xml
+++ b/reference/xdiff/functions/xdiff-string-rabdiff.xml
@@ -1,29 +1,33 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
+<!-- Corrected function signature and description for xdiff_string_rabdiff -->
 <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>
+  <refpurpose>Make a 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>
+   <type>string|false</type><methodname>xdiff_string_rabdiff</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>.
+   Makes a binary diff of two strings using the Rabin's polynomial fingerprinting algorithm implemented by
+   <link xlink:href="&url.xdiff;">libxdiff</link>. Compared to
+   <function>xdiff_string_bdiff</function>, this algorithm generally produces smaller diffs and operates faster,
+   while remaining fully compatible with <function>xdiff_string_bpatch</function> and
+   <function>xdiff_file_bpatch</function> for applying patches.
+  </para>
+  <para>
+   This function can be used with both text and binary data. The resulting diff data can later be applied to recreate
+   the new version from the old one.
   </para>
   <para>
-   For more details about differences between algorithm used please check <link xlink:href="&url.xdiff;">libxdiff</link> 
-   website.
+   For further information about the algorithm, see the
+   <link xlink:href="https://www.xmailserver.org/xdiff-lib.html">libxdiff documentation</link>.
   </para>
  </refsect1>
 
@@ -35,7 +39,7 @@
      <term><parameter>old_data</parameter></term>
      <listitem>
       <para>
-       First string with binary data. It acts as "old" data.
+       The first string containing the "old" binary data.
       </para>
      </listitem>
     </varlistentry>
@@ -43,7 +47,7 @@
      <term><parameter>new_data</parameter></term>
      <listitem>
       <para>
-       Second string with binary data. It acts as "new" data.
+       The second string containing the "new" binary data.
       </para>
      </listitem>
     </varlistentry>
@@ -54,8 +58,31 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns string with binary diff containing differences between "old" and "new"
-   data or &false; if an internal error occurred.
+   Returns a binary diff string containing the differences between the old and new data, or
+   <constant>false</constant> if an internal error occurred.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><function>xdiff_string_rabdiff</function> example</title>
+    <para>
+     The following example creates a binary diff between two strings and stores it for later patching.
+    </para>
+    <programlisting role="php">
+     <![CDATA[
+<?php
+$old = file_get_contents('file_v1.txt');
+$new = file_get_contents('file_v2.txt');
+
+$diff = xdiff_string_rabdiff($old, $new);
+file_put_contents('patch.rdiff', $diff);
+?>
+]]>
+    </programlisting>
+   </example>
   </para>
  </refsect1>
 
@@ -63,30 +90,32 @@
   &reftitle.seealso;
   <para>
    <simplelist>
+    <member><function>xdiff_string_bdiff</function></member>
     <member><function>xdiff_string_bpatch</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:"~/.phpdoc/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
--->
+ <!-- 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:"~/.phpdoc/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
+ -->

From 2244b9edb7d8406fc807e82b80a64d7ca545e967 Mon Sep 17 00:00:00 2001
From: Louis-Arnaud <20201470+lacatoire@users.noreply.github.com>
Date: Tue, 18 Nov 2025 09:56:18 +0100
Subject: [PATCH 2/8] Update reference/xdiff/functions/xdiff-string-rabdiff.xml

Co-authored-by: Kamil Tekiela <tekiela246@gmail.com>
---
 reference/xdiff/functions/xdiff-string-rabdiff.xml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/reference/xdiff/functions/xdiff-string-rabdiff.xml b/reference/xdiff/functions/xdiff-string-rabdiff.xml
index f714967cb389..2f126c6400f4 100644
--- a/reference/xdiff/functions/xdiff-string-rabdiff.xml
+++ b/reference/xdiff/functions/xdiff-string-rabdiff.xml
@@ -4,7 +4,9 @@
 <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 a binary diff of two strings using the Rabin's polynomial fingerprinting algorithm</refpurpose>
+  <refpurpose>
+   Make a binary diff of two strings using the Rabin's polynomial fingerprinting algorithm
+  </refpurpose>
  </refnamediv>
 
  <refsect1 role="description">

From f9e0925495e7affb7dca11a5ab67114f340ad7bb Mon Sep 17 00:00:00 2001
From: Louis-Arnaud <20201470+lacatoire@users.noreply.github.com>
Date: Tue, 18 Nov 2025 10:02:20 +0100
Subject: [PATCH 3/8] Apply suggestion from @kamil-tekiela

Co-authored-by: Kamil Tekiela <tekiela246@gmail.com>
---
 reference/xdiff/functions/xdiff-string-rabdiff.xml | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/reference/xdiff/functions/xdiff-string-rabdiff.xml b/reference/xdiff/functions/xdiff-string-rabdiff.xml
index 2f126c6400f4..eace6177d44c 100644
--- a/reference/xdiff/functions/xdiff-string-rabdiff.xml
+++ b/reference/xdiff/functions/xdiff-string-rabdiff.xml
@@ -60,8 +60,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns a binary diff string containing the differences between the old and new data, or
-   <constant>false</constant> if an internal error occurred.
+   Returns a binary diff string containing the differences between the old and new data,&return.falseforfailure;.
   </para>
  </refsect1>
 

From 0c0c72a128a73ea41f8bb935a2597259432e10ba Mon Sep 17 00:00:00 2001
From: lacatoire <louis-arnaud.catoire@external.drivalia.com>
Date: Tue, 18 Nov 2025 10:03:50 +0100
Subject: [PATCH 4/8] correct reviews

---
 .../xdiff/functions/xdiff-string-rabdiff.xml  | 52 +++++++++----------
 1 file changed, 26 insertions(+), 26 deletions(-)

diff --git a/reference/xdiff/functions/xdiff-string-rabdiff.xml b/reference/xdiff/functions/xdiff-string-rabdiff.xml
index eace6177d44c..5607c465862c 100644
--- a/reference/xdiff/functions/xdiff-string-rabdiff.xml
+++ b/reference/xdiff/functions/xdiff-string-rabdiff.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- Corrected function signature and description for xdiff_string_rabdiff -->
-<refentry xml:id="function.xdiff-string-rabdiff" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<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>
@@ -24,8 +24,8 @@
    <function>xdiff_file_bpatch</function> for applying patches.
   </para>
   <para>
-   This function can be used with both text and binary data. The resulting diff data can later be applied to recreate
-   the new version from the old one.
+   This function can be used with both text and binary data. The resulting diff data can later be 
+   applied to recreate the new version from the old one.
   </para>
   <para>
    For further information about the algorithm, see the
@@ -70,7 +70,7 @@
    <example>
     <title><function>xdiff_string_rabdiff</function> example</title>
     <para>
-     The following example creates a binary diff between two strings and stores it for later patching.
+     Creation of a binary diff between two strings
     </para>
     <programlisting role="php">
      <![CDATA[
@@ -99,24 +99,24 @@ file_put_contents('patch.rdiff', $diff);
  </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:"~/.phpdoc/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
- -->
+ 
+<!-- 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:"~/.phpdoc/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
+-->

From 116e0b0b395e5e99d08cdd111ad98dfb88224a9c Mon Sep 17 00:00:00 2001
From: Louis-Arnaud <20201470+lacatoire@users.noreply.github.com>
Date: Tue, 18 Nov 2025 14:48:41 +0100
Subject: [PATCH 5/8] Update reference/xdiff/functions/xdiff-string-rabdiff.xml

Co-authored-by: Kamil Tekiela <tekiela246@gmail.com>
---
 reference/xdiff/functions/xdiff-string-rabdiff.xml | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)

diff --git a/reference/xdiff/functions/xdiff-string-rabdiff.xml b/reference/xdiff/functions/xdiff-string-rabdiff.xml
index 5607c465862c..34a18c9bcf51 100644
--- a/reference/xdiff/functions/xdiff-string-rabdiff.xml
+++ b/reference/xdiff/functions/xdiff-string-rabdiff.xml
@@ -68,10 +68,7 @@
   &reftitle.examples;
   <para>
    <example>
-    <title><function>xdiff_string_rabdiff</function> example</title>
-    <para>
-     Creation of a binary diff between two strings
-    </para>
+    <title>Creation of a binary diff between two strings</title>
     <programlisting role="php">
      <![CDATA[
 <?php

From e6d3d7c7e61c0d25dadcffc372def8ca6ab5099c Mon Sep 17 00:00:00 2001
From: Louis-Arnaud <20201470+lacatoire@users.noreply.github.com>
Date: Tue, 18 Nov 2025 15:00:47 +0100
Subject: [PATCH 6/8] Update reference/xdiff/functions/xdiff-string-rabdiff.xml

Co-authored-by: Kamil Tekiela <tekiela246@gmail.com>
---
 reference/xdiff/functions/xdiff-string-rabdiff.xml | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/reference/xdiff/functions/xdiff-string-rabdiff.xml b/reference/xdiff/functions/xdiff-string-rabdiff.xml
index 34a18c9bcf51..2a8b23c17ce0 100644
--- a/reference/xdiff/functions/xdiff-string-rabdiff.xml
+++ b/reference/xdiff/functions/xdiff-string-rabdiff.xml
@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<refentry xml:id="function.xdiff-string-rabdiff" xmlns="http://docbook.org/ns/docbook" 
-          xmlns:xlink="http://www.w3.org/1999/xlink">
+<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>

From d442ee08ebed32b534d5e4d21737ec67ac48c146 Mon Sep 17 00:00:00 2001
From: Louis-Arnaud <20201470+lacatoire@users.noreply.github.com>
Date: Tue, 18 Nov 2025 15:00:53 +0100
Subject: [PATCH 7/8] Update reference/xdiff/functions/xdiff-string-rabdiff.xml

Co-authored-by: Kamil Tekiela <tekiela246@gmail.com>
---
 reference/xdiff/functions/xdiff-string-rabdiff.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/reference/xdiff/functions/xdiff-string-rabdiff.xml b/reference/xdiff/functions/xdiff-string-rabdiff.xml
index 2a8b23c17ce0..f09561d810a1 100644
--- a/reference/xdiff/functions/xdiff-string-rabdiff.xml
+++ b/reference/xdiff/functions/xdiff-string-rabdiff.xml
@@ -23,7 +23,7 @@
    <function>xdiff_file_bpatch</function> for applying patches.
   </para>
   <para>
-   This function can be used with both text and binary data. The resulting diff data can later be 
+   This function can be used with both text and binary data. The resulting diff data can later be
    applied to recreate the new version from the old one.
   </para>
   <para>

From dd05a3f10485bdf58db2b32d95a745058a59618a Mon Sep 17 00:00:00 2001
From: Louis-Arnaud <20201470+lacatoire@users.noreply.github.com>
Date: Tue, 18 Nov 2025 15:00:59 +0100
Subject: [PATCH 8/8] Update reference/xdiff/functions/xdiff-string-rabdiff.xml

Co-authored-by: Kamil Tekiela <tekiela246@gmail.com>
---
 reference/xdiff/functions/xdiff-string-rabdiff.xml | 1 -
 1 file changed, 1 deletion(-)

diff --git a/reference/xdiff/functions/xdiff-string-rabdiff.xml b/reference/xdiff/functions/xdiff-string-rabdiff.xml
index f09561d810a1..9f5325f42924 100644
--- a/reference/xdiff/functions/xdiff-string-rabdiff.xml
+++ b/reference/xdiff/functions/xdiff-string-rabdiff.xml
@@ -95,7 +95,6 @@ file_put_contents('patch.rdiff', $diff);
  </refsect1>
 
 </refentry>
- 
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml