From: W. Felix Handte <w@felixhandte.com>
Date: Thu, 10 Sep 2020 22:22:49 +0000 (-0400)
Subject: Document searchFuncs Table
X-Git-Tag: v1.4.7~80^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c5fab8848ab9d643cabd6d84f9ae65b76e726fb5;p=thirdparty%2Fzstd.git

Document searchFuncs Table
---

diff --git a/lib/compress/zstd_lazy.c b/lib/compress/zstd_lazy.c
index f84215223..49ec1b09e 100644
--- a/lib/compress/zstd_lazy.c
+++ b/lib/compress/zstd_lazy.c
@@ -872,6 +872,12 @@ ZSTD_compressBlock_lazy_generic(
                         ZSTD_matchState_t* ms,
                         const BYTE* ip, const BYTE* iLimit, size_t* offsetPtr);
 
+    /**
+     * This table is indexed first by the four ZSTD_dictMode_e values, and then
+     * by the two searchMethod_e values. NULLs are placed for configurations
+     * that should never occur (extDict modes go to the other implementation
+     * below and there is no DDSS for binary tree search yet).
+     */
     const searchMax_f searchFuncs[4][2] = {
         {
             ZSTD_HcFindBestMatch_selectMLS,