From: Yann Collet <cyan@fb.com>
Date: Fri, 25 Oct 2024 23:25:02 +0000 (-0700)
Subject: update ZSTD_splitBlock() documentation
X-Git-Tag: v1.5.7^2~69^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5b4ce643f03a2cc2c6f4e10dca3332c058f165d5;p=thirdparty%2Fzstd.git

update ZSTD_splitBlock() documentation
---

diff --git a/lib/compress/zstd_preSplit.h b/lib/compress/zstd_preSplit.h
index 07d7d4ef5..d606a52b5 100644
--- a/lib/compress/zstd_preSplit.h
+++ b/lib/compress/zstd_preSplit.h
@@ -19,14 +19,16 @@ extern "C" {
 
 #define ZSTD_SLIPBLOCK_WORKSPACESIZE 8208
 
-/* @level must be a value between 0 and 3.
- *        higher levels spend more energy to find block boundaries
- * @workspace must be aligned on 8-bytes boundaries
+/* ZSTD_splitBlock():
+ * @level must be a value between 0 and 4.
+ *        higher levels spend more energy to detect block boundaries.
+ * @workspace must be aligned for size_t.
  * @wkspSize must be at least >= ZSTD_SLIPBLOCK_WORKSPACESIZE
- * note2:
- * for the time being, this function only accepts full 128 KB blocks,
- * therefore @blockSizeMax must be == 128 KB.
- * This could be extended to smaller sizes in the future.
+ * note:
+ * For the time being, this function only accepts full 128 KB blocks.
+ * Therefore, @blockSize must be == 128 KB.
+ * While this could be extended to smaller sizes in the future,
+ * it is not yet clear if this would be useful. TBD.
  */
 size_t ZSTD_splitBlock(const void* blockStart, size_t blockSize,
                     int level,