From: Anatol Belski <ab@php.net>
Date: Sun, 21 Feb 2021 12:33:21 +0000 (+0100)
Subject: UPGRADING: Add note about xxHash secret and fix a typo
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=6055b72d0eaabdf164857255640e1808b433fed9;p=php

UPGRADING: Add note about xxHash secret and fix a typo

[ci skip]

Signed-off-by: Anatol Belski <ab@php.net>
---

diff --git a/UPGRADING b/UPGRADING
index 0bc8f81808..eb01058a5a 100644
--- a/UPGRADING
+++ b/UPGRADING
@@ -166,6 +166,16 @@ PHP 8.1 UPGRADE NOTES
     echo $h, "\n";
     ```
 
+    Secret usage is supported through passing the `secret` key in the `$options` array, too:
+
+    ```php
+    $h = hash("xxh3", $data, options: ["secret" => "at least 136 bytes long secret here"]);
+    echo $h, "\n";
+    ```
+
+    Note, that the quality of the custom secret is crucial for the quality of the resulting hash. It is
+    highly recommended for the secret to use the best possible entropy.
+
 - PDO SQLite:
   . SQLite's "file:" DSN syntax is now supported, which allows specifying
     additional flags. This feature is not available if open_basedir is set.
diff --git a/UPGRADING.INTERNALS b/UPGRADING.INTERNALS
index 39b26f3dae..8c001a67e7 100644
--- a/UPGRADING.INTERNALS
+++ b/UPGRADING.INTERNALS
@@ -22,9 +22,8 @@ PHP 8.1 INTERNALS UPGRADE NOTES
   a. ext/hash
     - The init signatures are extended with an additional `HashTable*`
       argument. The passed HT is to contain the algorithm specific
-      configuration. If the an algorithm doesn't make use of any
-      additional configuration, the argument is to be marked with
-      ZEND_ATTRIBUTE_UNUSED.
+      configuration. If an algorithm doesn't make use of any additional
+      configuration, the argument is to be marked with ZEND_ATTRIBUTE_UNUSED.
 
   b. ext/pdo
     - The "preparer" callback now accepts a zend_string* instead of