From: W. Felix Handte <w@felixhandte.com>
Date: Wed, 11 May 2022 16:38:20 +0000 (-0400)
Subject: Fix Comments Slightly
X-Git-Tag: v1.5.4^2~213^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1dd046a50783ebc4d0eb10928e71b2dd7c71cd4c;p=thirdparty%2Fzstd.git

Fix Comments Slightly
---

diff --git a/lib/compress/zstd_fast.c b/lib/compress/zstd_fast.c
index 11c80af87..f51911eb9 100644
--- a/lib/compress/zstd_fast.c
+++ b/lib/compress/zstd_fast.c
@@ -183,7 +183,9 @@ _start: /* Requires: ip0 */
             offcode = REPCODE1_TO_OFFBASE;
             mLength += 4;
 
-            /* first write next hash table entry; we've already calculated it */
+            /* First write next hash table entry; we've already calculated it.
+             * This write is known to be safe because the ip1 is before the
+             * repcode (ip2). */
             hashTable[hash1] = (U32)(ip1 - base);
 
             goto _match;
@@ -200,7 +202,9 @@ _start: /* Requires: ip0 */
         if (MEM_read32(ip0) == mval) {
             /* found a match! */
 
-            /* first write next hash table entry; we've already calculated it */
+            /* First write next hash table entry; we've already calculated it.
+             * This write is known to be safe because the ip1 == ip0 + 1, so
+             * we know we will resume searching after ip1 */
             hashTable[hash1] = (U32)(ip1 - base);
 
             goto _offset;
@@ -242,12 +246,7 @@ _start: /* Requires: ip0 */
                  * The minimum possible match has length 4, so the earliest ip0
                  * can be after we take this match will be the current ip0 + 4.
                  * ip1 is ip0 + step - 1. If ip1 is >= ip0 + 4, we can't safely
-                 * write this position. The expedient thing to do is just to
-                 * write a bad position.
-                 *
-                 * We perform this check here, separate from the write, because
-                 * this is the only match path where this can occur. (In rep-
-                 * code and the first match checks, ip1 == ip0 + 1.)
+                 * write this position.
                  */
                 hashTable[hash1] = (U32)(ip1 - base);
             }