From fd7773589d6e41c4657dcf6614c4eeddb1fd87b0 Mon Sep 17 00:00:00 2001
From: AllenJB <AllenJB@users.noreply.github.com>
Date: Sat, 3 May 2025 15:02:25 +0100
Subject: [PATCH 1/3] strcmp: Improve behavior description and direct users to
 alternative functions (strcoll and Collator::compare) where appropriate; Add
 the "similarity" functions to seealso Removed substr from seealso (why is it
 here?)

---
 reference/strings/functions/strcmp.xml | 41 ++++++++++++++++++++------
 1 file changed, 32 insertions(+), 9 deletions(-)

diff --git a/reference/strings/functions/strcmp.xml b/reference/strings/functions/strcmp.xml
index f34c127bf74f..3767927e7112 100644
--- a/reference/strings/functions/strcmp.xml
+++ b/reference/strings/functions/strcmp.xml
@@ -14,7 +14,10 @@
    <methodparam><type>string</type><parameter>string2</parameter></methodparam>
   </methodsynopsis>
   <simpara>
-   Note that this comparison is case sensitive.
+   Note that this comparison is case sensitive. See <function>strcasecmp</function>
+  </simpara>
+  <simpara>
+   Note that this comparison is not locale aware. See <function>strcoll</function> or <methodname>Collator::compare</methodname>
   </simpara>
  </refsect1>
 
@@ -87,14 +90,34 @@ if (strcmp($var1, $var2) !== 0) {
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
-   <simplelist>
-    <member><function>strcasecmp</function></member>
-    <member><function>preg_match</function></member>
-    <member><function>substr_compare</function></member>
-    <member><function>strncmp</function></member>
-    <member><function>strstr</function></member>
-    <member><function>substr</function></member>
-   </simplelist>
+   <itemizedlist>
+    <listitem>
+     <simpara>Full string comparison</simpara>
+     <simplelist>
+      <member><function>strcasecmp</function></member>
+      <member><methodname>Collator::compare</methodname></member>
+      <member><function>strcoll</function></member>
+     </simplelist>
+    </listitem>
+    <listitem>
+     <simpara>Partial string comparison</simpara>
+     <simplelist>
+      <member><function>substr_compare</function></member>
+      <member><function>strncmp</function></member>
+      <member><function>strstr</function></member>
+     </simplelist>
+    </listitem>
+    <listitem>
+     <simpara>Similar / other string comparison</simpara>
+     <simplelist>
+      <member><function>preg_match</function></member>
+      <member><function>levenshtein</function></member>
+      <member><function>metaphone</function></member>
+      <member><function>similar_text</function></member>
+      <member><function>soundex</function></member>
+     </simplelist>
+    </listitem>
+   </itemizedlist>
   </para>
  </refsect1>
 

From a484399869fe22755b7a31d1f5cf2bd34127d4c8 Mon Sep 17 00:00:00 2001
From: AllenJB <AllenJB@users.noreply.github.com>
Date: Sat, 3 May 2025 15:06:53 +0100
Subject: [PATCH 2/3] Cross-link all the string similarity functions

---
 reference/strings/functions/metaphone.xml    | 10 ++++++++++
 reference/strings/functions/similar-text.xml |  1 +
 2 files changed, 11 insertions(+)

diff --git a/reference/strings/functions/metaphone.xml b/reference/strings/functions/metaphone.xml
index f9a10da1de5b..4e420f9ac8f5 100644
--- a/reference/strings/functions/metaphone.xml
+++ b/reference/strings/functions/metaphone.xml
@@ -155,6 +155,16 @@ string(6) "ASTRKS"
   </para>
  </refsect1><!-- }}} -->
 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>levenshtein</function></member>
+    <member><function>similar_text</function></member>
+    <member><function>soundex</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/strings/functions/similar-text.xml b/reference/strings/functions/similar-text.xml
index d3ea50b2b997..4cec351f0384 100644
--- a/reference/strings/functions/similar-text.xml
+++ b/reference/strings/functions/similar-text.xml
@@ -110,6 +110,7 @@ similarity: 3 (42.857142857143 %)
   <para>
    <simplelist>
     <member><function>levenshtein</function></member>
+    <member><function>metaphone</function></member>
     <member><function>soundex</function></member>
    </simplelist>
   </para>

From 7006dc80178223a7130cfcabb6c8cce4913f8a3c Mon Sep 17 00:00:00 2001
From: AllenJB <AllenJB@users.noreply.github.com>
Date: Sat, 3 May 2025 15:21:08 +0100
Subject: [PATCH 3/3] Trailing whitespace removal

---
 reference/strings/functions/levenshtein.xml  | 4 ++--
 reference/strings/functions/metaphone.xml    | 2 +-
 reference/strings/functions/similar-text.xml | 2 +-
 reference/strings/functions/soundex.xml      | 2 +-
 reference/strings/functions/strcmp.xml       | 4 ++--
 5 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/reference/strings/functions/levenshtein.xml b/reference/strings/functions/levenshtein.xml
index b9a1f46b967b..f8f783ce8661 100644
--- a/reference/strings/functions/levenshtein.xml
+++ b/reference/strings/functions/levenshtein.xml
@@ -5,7 +5,7 @@
   <refname>levenshtein</refname>
   <refpurpose>Calculate Levenshtein distance between two strings</refpurpose>
  </refnamediv>
- 
+
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
@@ -83,7 +83,7 @@
    </variablelist>
   </para>
  </refsect1>
- 
+
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
diff --git a/reference/strings/functions/metaphone.xml b/reference/strings/functions/metaphone.xml
index 4e420f9ac8f5..ce5f7921dbfa 100644
--- a/reference/strings/functions/metaphone.xml
+++ b/reference/strings/functions/metaphone.xml
@@ -5,7 +5,7 @@
   <refname>metaphone</refname>
   <refpurpose>Calculate the metaphone key of a string</refpurpose>
  </refnamediv>
- 
+
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
diff --git a/reference/strings/functions/similar-text.xml b/reference/strings/functions/similar-text.xml
index 4cec351f0384..7756b73882d5 100644
--- a/reference/strings/functions/similar-text.xml
+++ b/reference/strings/functions/similar-text.xml
@@ -5,7 +5,7 @@
   <refname>similar_text</refname>
   <refpurpose>Calculate the similarity between two strings</refpurpose>
  </refnamediv>
- 
+
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
diff --git a/reference/strings/functions/soundex.xml b/reference/strings/functions/soundex.xml
index 093a3a37a372..a2adae346744 100644
--- a/reference/strings/functions/soundex.xml
+++ b/reference/strings/functions/soundex.xml
@@ -5,7 +5,7 @@
   <refname>soundex</refname>
   <refpurpose>Calculate the soundex key of a string</refpurpose>
  </refnamediv>
- 
+
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
diff --git a/reference/strings/functions/strcmp.xml b/reference/strings/functions/strcmp.xml
index 3767927e7112..fbc85e7e5f55 100644
--- a/reference/strings/functions/strcmp.xml
+++ b/reference/strings/functions/strcmp.xml
@@ -5,7 +5,7 @@
   <refname>strcmp</refname>
   <refpurpose>Binary safe string comparison</refpurpose>
  </refnamediv>
- 
+
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
@@ -86,7 +86,7 @@ if (strcmp($var1, $var2) !== 0) {
    </example>   
   </para>
  </refsect1>
- 
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>