[doc-en] master: mhash: fix the constants page and document the 8.5 deprecation (#5875)
| From: | Louis-Arnaud via GitHub | Date: | Wed, 07 Oct 2026 21:53:07 +0000 |
| Subject: | [doc-en] master: mhash: fix the constants page and document the 8.5 deprecation (#5875) | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-23819@lists.php.net to get a copy of this message | ||
Author: Louis-Arnaud (lacatoire)
Committer: GitHub (web-flow)
Pusher: kamil-tekiela
Date: 2026-10-07T22:53:04+01:00
Commit: https://github.com/php/doc-en/commit/99a687b41b2d9578f5c6c6702a76d545feb8ecec
Raw diff: https://github.com/php/doc-en/commit/99a687b41b2d9578f5c6c6702a76d545feb8ecec.diff
mhash: fix the constants page and document the 8.5 deprecation (#5875)
Changed paths:
M reference/mhash/configure.xml
M reference/mhash/constants.xml
M reference/mhash/setup.xml
M reference/mhash/versions.xml
Diff:
diff --git a/reference/mhash/configure.xml b/reference/mhash/configure.xml
index f97526b5bcdc..ef31157cd273 100644
--- a/reference/mhash/configure.xml
+++ b/reference/mhash/configure.xml
@@ -2,17 +2,17 @@
<!-- $Revision$ -->
<section xml:id="mhash.installation" xmlns="http://docbook.org/ns/docbook">
&reftitle.install;
- <para>
+ <simpara>
You need to compile PHP with the
- <option role="configure">--with-mhash[=DIR]</option> parameter to enable
- this extension. DIR is the mhash installation directory.
- </para>
- <para>
- As of PHP 5.3.0, the mhash extension is emulated thru the
- <link linkend="ref.hash">Hash</link> extension. This makes
- the mhash installation directory have no effect, and requires
- the hash extension enabled to make the mhash support available.
- </para>
+ <option role="configure">--with-mhash</option> parameter to enable
+ this extension.
+ </simpara>
+ <simpara>
+ The mhash functions are provided by the <link
linkend="ref.hash">Hash</link>
+ extension, which is always available. The
+ <option role="configure">--with-mhash</option> option is deprecated as of
+ PHP 8.1.0 and emits a warning at configure time.
+ </simpara>
</section>
<!-- Keep this comment at the end of the file
diff --git a/reference/mhash/constants.xml b/reference/mhash/constants.xml
index b22f8cca53b3..8782efd6212e 100644
--- a/reference/mhash/constants.xml
+++ b/reference/mhash/constants.xml
@@ -3,6 +3,12 @@
<appendix xml:id="mhash.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
+ <warning>
+ <simpara>
+ All <constant>MHASH_<replaceable>*</replaceable></constant> constants
are
+ deprecated as of PHP 8.5.0.
+ </simpara>
+ </warning>
<para>
Here is a list of hashes which are currently supported by mhash. If a
hash is not listed here, but it is listed in the mhash documentation
@@ -337,7 +343,9 @@
(<type>int</type>)
</term>
<listitem>
- <simpara></simpara>
+ <simpara>
+ Available as of PHP 8.1.0.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.mhash-xxh64">
@@ -346,7 +354,9 @@
(<type>int</type>)
</term>
<listitem>
- <simpara></simpara>
+ <simpara>
+ Available as of PHP 8.1.0.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.mhash-xxh3">
@@ -355,7 +365,9 @@
(<type>int</type>)
</term>
<listitem>
- <simpara></simpara>
+ <simpara>
+ Available as of PHP 8.1.0.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.mhash-xxh128">
@@ -364,7 +376,9 @@
(<type>int</type>)
</term>
<listitem>
- <simpara></simpara>
+ <simpara>
+ Available as of PHP 8.1.0.
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
diff --git a/reference/mhash/setup.xml b/reference/mhash/setup.xml
index dedb6d0b5dcf..9f233832b31a 100644
--- a/reference/mhash/setup.xml
+++ b/reference/mhash/setup.xml
@@ -7,11 +7,11 @@
<!-- {{{ Requirements -->
<section xml:id="mhash.requirements">
&reftitle.required;
- <para>
- To use it, download the mhash distribution from <link
- xlink:href="&url.mhash;">its web site</link> and follow the included
- installation instructions.
- </para>
+ <simpara>
+ No external library is needed to build this extension; the mhash functions
+ are provided as a backward compatibility layer by the
+ <link linkend="ref.hash">Hash</link> extension.
+ </simpara>
</section>
<!-- }}} -->
diff --git a/reference/mhash/versions.xml b/reference/mhash/versions.xml
index de26033d09d6..a4c42cd63f67 100644
--- a/reference/mhash/versions.xml
+++ b/reference/mhash/versions.xml
@@ -2,11 +2,11 @@
<?do-not-translate?>
<versions>
- <function name="mhash" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
- <function name="mhash_count" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
- <function name="mhash_get_block_size" from="PHP 4, PHP 5, PHP 7, PHP
8"/>
- <function name="mhash_get_hash_name" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
- <function name="mhash_keygen_s2k" from="PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP
8"/>
+ <function name="mhash" from="PHP 4, PHP 5, PHP 7, PHP 8"
deprecated="PHP 8.1.0"/>
+ <function name="mhash_count" from="PHP 4, PHP 5, PHP 7, PHP 8"
deprecated="PHP 8.1.0"/>
+ <function name="mhash_get_block_size" from="PHP 4, PHP 5, PHP 7, PHP 8"
deprecated="PHP 8.1.0"/>
+ <function name="mhash_get_hash_name" from="PHP 4, PHP 5, PHP 7, PHP 8"
deprecated="PHP 8.1.0"/>
+ <function name="mhash_keygen_s2k" from="PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP
8" deprecated="PHP 8.1.0"/>
</versions>
<!-- Keep this comment at the end of the file